[][src]Crate slab_typesafe

A type-safe wrapper for slab. It implements the same data structure with the same methods, but takes and returns special tokens instead of usize values, preventing you from confusing them with other unrelated usizes, including keys for other Slab instances.

The protection is shallow, as the tokens implement From and Into. Additionally, entire slab may be converted back and forth between wrapped typesafe and unwrapped usize versions.

Based on compactmap::wrapped

Examples

Basic storing and retrieval.

#[macro_use]
extern crate slab_typesafe;
declare_slab_token!(StringHandle);
let mut slab : Slab<StringHandle, &'static str> = Slab::new();

let hello = slab.insert("hello");
let world = slab.insert("world");

assert_eq!(slab[hello], "hello");
assert_eq!(slab[world], "world");

slab[world] = "earth";
assert_eq!(slab[world], "earth");

Error if you confused the handles

This example deliberately fails to compile
#[macro_use]
extern crate slab_typesafe;
declare_slab_token!(StringHandle1);
declare_slab_token!(StringHandle2);
let mut slab1 : Slab<StringHandle1, _> = Slab::new();
let mut slab2 : Slab<StringHandle2, _> = Slab::new();

let hello = slab1.insert("hello");
let world = slab2.insert("world");

slab1[world]; // the type `Slab<StringHandle1, _>` cannot be indexed by `StringHandle2`
slab2.remove(hello); // expected struct `StringHandle2`, found struct `StringHandle1`

See the rest of examples in the original documentation.

The documentation is mostly a copy of the original crate's documentation.

Macros

declare_slab_token

Create usize-equivalent struct that implements From<usize> and Into<usize>

Structs

Iter

An iterator over the values stored in the Slab

IterMut

A mutable iterator over the values stored in the Slab

Slab

A wrapper for pre-allocated storage for a uniform data type

VacantEntry

A handle to an vacant entry in a Slab.