third_party/rust/slab/README.md

   1 # Slab
   2
   3 Pre-allocated storage for a uniform data type.
   4
   5 [![Crates.io][crates-badge]][crates-url]
   6 [![Build Status][ci-badge]][ci-url]
   7
   8 [crates-badge]: https://img.shields.io/crates/v/slab
   9 [crates-url]: https://crates.io/crates/slab
  10 [ci-badge]: https://img.shields.io/github/actions/workflow/status/tokio-rs/slab/ci.yml?branch=master
  11 [ci-url]: https://github.com/tokio-rs/slab/actions
  12
  13 [Documentation](https://docs.rs/slab)
  14
  15 ## Usage
  16
  17 To use `slab`, first add this to your `Cargo.toml`:
  18
  19 ```toml
  20 [dependencies]
  21 slab = "0.4"
  22 ```
  23
  24 Next, add this to your crate:
  25
  26 ```rust
  27 use slab::Slab;
  28
  29 let mut slab = Slab::new();
  30
  31 let hello = slab.insert("hello");
  32 let world = slab.insert("world");
  33
  34 assert_eq!(slab[hello], "hello");
  35 assert_eq!(slab[world], "world");
  36
  37 slab[world] = "earth";
  38 assert_eq!(slab[world], "earth");
  39 ```
  40
  41 See [documentation](https://docs.rs/slab) for more details.
  42
  43 ## License
  44
  45 This project is licensed under the [MIT license](LICENSE).
  46
  47 ### Contribution
  48
  49 Unless you explicitly state otherwise, any contribution intentionally submitted
  50 for inclusion in `slab` by you, shall be licensed as MIT, without any additional
  51 terms or conditions.