# vec-arena (deprecated)

[![Build](https://github.com/smol-rs/vec-arena/workflows/Build%20and%20test/badge.svg)](
https://github.com/smol-rs/vec-arena/actions)
[![License](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](https://github.com/smol-rs/vec-arena)
[![Cargo](https://img.shields.io/crates/v/vec-arena.svg)](https://crates.io/crates/vec-arena)
[![Documentation](https://docs.rs/vec-arena/badge.svg)](https://docs.rs/vec-arena)

**This crate is now deprecated in favor of [slab](https://crates.io/crates/slab).**

#### What is this?

A simple object arena.

You want to build a doubly linked list? Or maybe a bidirectional tree? Perhaps an even more
complicated object graph?

Managing ownership and lifetimes might be tough then. Your options boil down to:

1. Use unsafe code to escape Rust's ownership rules.
2. Wrap every object in `Rc<RefCell<T>>`.
3. Use `Vec<T>` to store objects, then access them using indices.

If the last option seems most appealing to you, perhaps `Arena<T>` is for you.
It will provide a more convenient API than a plain `Vec<T>`.

#### Examples

Some data structures built using `Arena<T>`:

* [Doubly linked list](https://github.com/smol-rs/vec-arena/blob/master/examples/linked-list.rs)
* [Splay tree](https://github.com/smol-rs/vec-arena/blob/master/examples/splay-tree.rs)