vendor/sized-chunks/README.md

   1 # sized-chunks
   2
   3 Various fixed length array data types, designed for [immutable.rs].
   4
   5 ## Overview
   6
   7 This crate provides the core building blocks for the immutable data structures
   8 in [immutable.rs]: a sized array with O(1) amortised double ended push/pop and
   9 smarter insert/remove performance (used by `im::Vector` and `im::OrdMap`), and a
  10 fixed size sparse array (used by `im::HashMap`).
  11
  12 In a nutshell, this crate contains the unsafe bits from [immutable.rs], which
  13 may or may not be useful to anyone else, and have been split out for ease of
  14 auditing.
  15
  16 ## Documentation
  17
  18 * [API docs](https://docs.rs/sized-chunks)
  19
  20 ## Licence
  21
  22 Copyright 2019 Bodil Stokke
  23
  24 This software is subject to the terms of the Mozilla Public
  25 License, v. 2.0. If a copy of the MPL was not distributed with this
  26 file, You can obtain one at http://mozilla.org/MPL/2.0/.
  27
  28 ## Code of Conduct
  29
  30 Please note that this project is released with a [Contributor Code of
  31 Conduct][coc]. By participating in this project you agree to abide by its
  32 terms.
  33
  34 [immutable.rs]: https://immutable.rs/
  35 [coc]: https://github.com/bodil/sized-chunks/blob/master/CODE_OF_CONDUCT.md