#collections #vector #gamedev #generational-index

generational_vector

A vector type using generational indices

2 unstable releases

Uses new Rust 2021

0.2.0 Apr 15, 2022
0.1.0 Apr 15, 2022

#653 in Rust patterns

MIT license

24KB
426 lines

A generational indexing-based Vector

This crates provides a vector type that uses generational indices to access its elements. The addition of a generation counter to an index allows for invalidation of stale references to previously deleted vector entries.

The vector itself is backed by a free list to keep track of reusable holes after element removal.

use generational_vector::{GenerationalVector, DeletionResult};

fn example() {
    let mut v = GenerationalVector::default();

    // Adding elements.
    let a = v.push("first");
    let b = v.push("second");
    assert_eq!(v.get(&a).unwrap(), &"first");
    assert_eq!(v.get(&b).unwrap(), &"second");

    // Removing elements.
    v.remove(&b);
    assert!(v.get(&b).is_none());

    // Overwriting a previously freed slot.
    let c = v.push("third");
    assert_eq!(v.get(&c).unwrap(), &"third");

    // The previous index 'b' internally points to the
    // same address as c. It uses an older generation however,
    // so is considered "not found":
    assert_eq!(v.get(&b), None);

    // Values can be enumerated.
    // Note that the ordering depends on insertions and deletions.
    for value in v {
        println!("{}", value);
    }
}

The above script is taken from examples/example.rs and can be run using

cargo run --example example

You can find more usage examples in tests/tests.rs.

Benchmarks

This project uses Criterion for benchmarking. To execute the benchmarks, run

cargo criterion

Material and sources

Dependencies

~155KB