summaryrefslogtreecommitdiffstats
path: root/third_party/rust/equivalent/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-12 05:43:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-12 05:43:14 +0000
commit8dd16259287f58f9273002717ec4d27e97127719 (patch)
tree3863e62a53829a84037444beab3abd4ed9dfc7d0 /third_party/rust/equivalent/README.md
parentReleasing progress-linux version 126.0.1-1~progress7.99u1. (diff)
downloadfirefox-8dd16259287f58f9273002717ec4d27e97127719.tar.xz
firefox-8dd16259287f58f9273002717ec4d27e97127719.zip
Merging upstream version 127.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--third_party/rust/equivalent/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/third_party/rust/equivalent/README.md b/third_party/rust/equivalent/README.md
new file mode 100644
index 0000000000..8ff7e24c8c
--- /dev/null
+++ b/third_party/rust/equivalent/README.md
@@ -0,0 +1,25 @@
+# Equivalent
+
+[![crates.io](https://img.shields.io/crates/v/equivalent.svg)](https://crates.io/crates/equivalent)
+[![docs](https://docs.rs/equivalent/badge.svg)](https://docs.rs/equivalent)
+
+`Equivalent` and `Comparable` are Rust traits for key comparison in maps.
+
+These may be used in the implementation of maps where the lookup type `Q`
+may be different than the stored key type `K`.
+
+* `Q: Equivalent<K>` checks for equality, similar to the `HashMap<K, V>`
+ constraint `K: Borrow<Q>, Q: Eq`.
+* `Q: Comparable<K>` checks the ordering, similar to the `BTreeMap<K, V>`
+ constraint `K: Borrow<Q>, Q: Ord`.
+
+These traits are not used by the maps in the standard library, but they may
+add more flexibility in third-party map implementations, especially in
+situations where a strict `K: Borrow<Q>` relationship is not available.
+
+## License
+
+Equivalent 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) for details. Opening a pull request is
+assumed to signal agreement with these licensing terms.