summaryrefslogtreecommitdiffstats
path: root/third_party/rust/enum-map/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/rust/enum-map/README.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/enum-map/README.md')
-rw-r--r--third_party/rust/enum-map/README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/third_party/rust/enum-map/README.md b/third_party/rust/enum-map/README.md
new file mode 100644
index 0000000000..ca83e020cc
--- /dev/null
+++ b/third_party/rust/enum-map/README.md
@@ -0,0 +1,45 @@
+<!--
+SPDX-FileCopyrightText: 2017 - 2023 Kamila Borowska <kamila@borowska.pw>
+
+SPDX-License-Identifier: MIT OR Apache-2.0
+-->
+
+# enum-map
+
+A library providing enum map providing type safe enum array. It is
+implemented using regular Rust arrays, so using them is as fast
+as using regular Rust arrays.
+
+This crate follows the "N minus two" MSRV policy. This means that it
+supports the current Rust release, as well as the two before that.
+
+## Examples
+
+```rust
+#[macro_use]
+extern crate enum_map;
+
+use enum_map::EnumMap;
+
+#[derive(Debug, Enum)]
+enum Example {
+ A,
+ B,
+ C,
+}
+
+fn main() {
+ let mut map = enum_map! {
+ Example::A => 1,
+ Example::B => 2,
+ Example::C => 3,
+ };
+ map[Example::C] = 4;
+
+ assert_eq!(map[Example::A], 1);
+
+ for (key, &value) in &map {
+ println!("{:?} has {} as value.", key, value);
+ }
+}
+```