vecmap-rs 0.1.1

A vector-based map
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# vecmap-rs

[![Build Status](https://github.com/martinohmann/vecmap-rs/workflows/ci/badge.svg)](https://github.com/martinohmann/vecmap-rs/actions?query=workflow%3Aci)
[![crates.io](https://img.shields.io/crates/v/vecmap-rs)](https://crates.io/crates/vecmap-rs)
[![docs.rs](https://img.shields.io/docsrs/vecmap-rs)](https://docs.rs/vecmap-rs)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A vector-based ordered map implementation with zero dependencies and support
for `#![no_std]`.

Map keys are not required to be hashable and do not need to form a total order.
Therefore, `VecMap<K, V>` can be used with key types which neither implement
`Hash` nor `Ord`.

Since vecmap-rs is a `Vec<(K, V)>` under the hood, worst case lookup and
insertion performance is `O(n)` and scales with the number of map entries.
Thus, its main use case are small collections with unhashable keys.

For key types that implement `Hash` and `Ord` consider using a map implementation with better performance such as
[`HashMap`](https://doc.rust-lang.org/std/collections/struct.HashMap.html) and
[`BTreeMap`](https://doc.rust-lang.org/std/collections/struct.BTreeMap.html) from the standard library or popular alternatives like [`IndexMap`](https://docs.rs/indexmap/latest/indexmap/).

## Cargo features

The following features are available:

* `serde`: Provides `Serialize` and `Deserialize` implementations for `VecMap`.
  This feature is disabled by default. Enabling it will pull in `serde` as a
  dependency.

## License

The source code of vecmap-rs is licensed under either of [Apache License,
Version 2.0](LICENSE-APACHE.md) or [MIT license](LICENSE-MIT) at your option.