diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-30 03:57:19 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-30 03:57:19 +0000 |
commit | a0b8f38ab54ac451646aa00cd5e91b6c76f22a84 (patch) | |
tree | fc451898ccaf445814e26b46664d78702178101d /vendor/equivalent/README.md | |
parent | Adding debian version 1.71.1+dfsg1-2. (diff) | |
download | rustc-a0b8f38ab54ac451646aa00cd5e91b6c76f22a84.tar.xz rustc-a0b8f38ab54ac451646aa00cd5e91b6c76f22a84.zip |
Merging upstream version 1.72.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/equivalent/README.md')
-rw-r--r-- | vendor/equivalent/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/vendor/equivalent/README.md b/vendor/equivalent/README.md new file mode 100644 index 000000000..8ff7e24c8 --- /dev/null +++ b/vendor/equivalent/README.md @@ -0,0 +1,25 @@ +# Equivalent + +[](https://crates.io/crates/equivalent) +[](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. |