blazemap 0.5.0

Implements a vector-based slab-like map with an interface similar to that of HashMap, and also provides tools for generating lightweight identifiers that can be type-safely used as keys for this 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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# blazemap

_Implements a vector-based slab-like map with an interface similar to that of `HashMap`,
and also provides tools for generating lightweight identifiers that can be type-safely used as keys for this map._

[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]
[![MIT licensed][mit-badge]][mit-url]
[![Build Status][actions-badge]][actions-url]

[crates-badge]: https://img.shields.io/crates/v/blazemap.svg
[crates-url]: https://crates.io/crates/blazemap
[docs-badge]: https://img.shields.io/docsrs/blazemap
[docs-url]: https://docs.rs/blazemap
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/andrewsonin/blazemap/blob/master/LICENSE
[actions-badge]: https://github.com/andrewsonin/blazemap/actions/workflows/ci.yml/badge.svg
[actions-url]: https://github.com/andrewsonin/blazemap/actions/workflows/ci.yml

## Usage

Currently, this crate provides 3 ways to create new types based on `usize` that can be used as keys to `BlazeMap`.
They are represented by the following macros and provide different optimizations.

### 1. `define_key_wrapper!`

Creates a new type that acts as an `usize`-based replacement
for the old type that can be used as a key for `blazemap` collections.

#### Example

```rust
use blazemap::prelude::{BlazeMap, define_key_wrapper};

define_key_wrapper! {
    pub struct Key(&'static str);
    Derive(as for Original Type): {  // Optional section
        Debug,
        Display,
    };
    Derive(as for usize): {          // Optional section
        Ord,
    }
}

let key_1 = Key::new("first");
let key_2 = Key::new("second");
let key_3 = Key::new("third");

let mut map = BlazeMap::new();
map.insert(key_2, "2");
map.insert(key_1, "1");
map.insert(key_3, "3");

assert_eq!(format!("{map:?}"), r#"{"first": "1", "second": "2", "third": "3"}"#)
```

### 2. `define_key_wrapper_bounded!`

Creates a new type that acts as an `usize`-based replacement for the old
type that can be used as a key for `blazemap` collections.

Being an analogue of `define_key_wrapper!`
for the case when the user could statically guarantee
that the number of unique keys doesn't exceed `MAX_CAP`, it's optimized for
read operations so that they don't create any multi-thread contention.

#### Example

```rust
use blazemap::prelude::{BlazeMap, define_key_wrapper_bounded};

define_key_wrapper_bounded! {
    pub struct Key(&'static str);
    MAX_CAP = 40_000;
    Derive(as for Original Type): {  // Optional section
        Debug,
        Display,
    };
    Derive(as for usize): {          // Optional section
        Ord,
    }
}

let key_1 = Key::new("first");
let key_2 = Key::new("second");
let key_3 = Key::new("third");

let mut map = BlazeMap::new();
map.insert(key_2, "2");
map.insert(key_1, "1");
map.insert(key_3, "3");

assert_eq!(format!("{map:?}"), r#"{"first": "1", "second": "2", "third": "3"}"#)
```

### 3. `define_plain_id!`

Creates a new type based on incrementally generated `usize` instances
that can be used as a key for `blazemap` collections. This is the most performant way to generate keys for `BlazeMap`.

#### Example
```rust
use blazemap::prelude::{BlazeMap, define_plain_id};

define_plain_id! {
    pub struct Id;
    Derive: {       // Optional section
        Ord
    };
}

let key_1 = Id::new();
let key_2 = Id::new();
let key_3 = Id::new();

let mut map = BlazeMap::new();
map.insert(key_2, "2");
map.insert(key_1, "1");
map.insert(key_3, "3");

assert_eq!(format!("{map:?}"), r#"{0: "1", 1: "2", 2: "3"}"#)
```