summaryrefslogtreecommitdiffstats
path: root/vendor/litemap/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:18:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:18:32 +0000
commit4547b622d8d29df964fa2914213088b148c498fc (patch)
tree9fc6b25f3c3add6b745be9a2400a6e96140046e9 /vendor/litemap/README.md
parentReleasing progress-linux version 1.66.0+dfsg1-1~progress7.99u1. (diff)
downloadrustc-4547b622d8d29df964fa2914213088b148c498fc.tar.xz
rustc-4547b622d8d29df964fa2914213088b148c498fc.zip
Merging upstream version 1.67.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/litemap/README.md')
-rw-r--r--vendor/litemap/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/vendor/litemap/README.md b/vendor/litemap/README.md
new file mode 100644
index 000000000..69700a31b
--- /dev/null
+++ b/vendor/litemap/README.md
@@ -0,0 +1,26 @@
+# litemap [![crates.io](https://img.shields.io/crates/v/litemap)](https://crates.io/crates/litemap)
+
+## `litemap`
+
+`litemap` is a crate providing [`LiteMap`], a highly simplistic "flat" key-value map
+based off of a single sorted vector.
+
+The goal of this crate is to provide a map that is good enough for small
+sizes, and does not carry the binary size impact of [`HashMap`](std::collections::HashMap)
+or [`BTreeMap`](alloc::collections::BTreeMap).
+
+If binary size is not a concern, [`std::collections::BTreeMap`] may be a better choice
+for your use case. It behaves very similarly to [`LiteMap`] for less than 12 elements,
+and upgrades itself gracefully for larger inputs.
+
+### Pluggable Backends
+
+By default, [`LiteMap`] is backed by a [`Vec`]; however, it can be backed by any appropriate
+random-access data store, giving that data store a map-like interface. See the [`store`]
+module for more details.
+
+[`Vec`]: alloc::vec::Vec
+
+## More Information
+
+For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x).