colony 0.2.0

A fast associative data-structure that chooses its own keys
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
36
37

# Colony

[![Tests](https://github.com/LlewVallis/colony/actions/workflows/ci.yml/badge.svg)](https://github.com/LlewVallis/colony/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/colony)](https://crates.io/crates/colony)
[![Docs](https://img.shields.io/docsrs/colony)](https://docs.rs/colony)

An unordered data-structure with `O(1)` lookup, removal, iteration and `O(1)` amortized insertion.
Like a faster `HashMap` that chooses its own keys.
Also similar to a `Vec<Option<T>>`, where instead of calling `Vec::remove` elements are removed by setting the element to `None`.

See [the documentation](https://docs.rs/colony) for more information.

This crate is partly a port of [`plf::colony`](https://plflib.org/colony.htm), which is a
[proposed addition](https://isocpp.org/files/papers/P0447R16.html)
to the C++ standard library under the name `std::hive`.

## Example

```rust
let mut colony = Colony::new();

// Insert
let foo_handle = colony.insert("foo");
let bar_handle = colony.insert("bar");

// Remove
assert_eq!(colony.remove(foo_handle), Some("foo"));

// Lookup
assert_eq!(colony.get(foo_handle), None);
assert_eq!(colony.get(bar_handle), Some(&"bar"));

// Iteration
for (key, &value) in colony.iter() {
    assert_eq!((key, value), (bar_handle, "bar"));
}
```