https://github.com/llogiq/compact_arena

A crate with indexed arenas with small memory footprint
https://github.com/llogiq/compact_arena

hacktoberfest

Last synced: 6 days ago
JSON representation

A crate with indexed arenas with small memory footprint

• Host: GitHub
• URL: https://github.com/llogiq/compact_arena
• Owner: llogiq
• License: apache-2.0
• Created: 2019-03-22T07:42:13.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-26T20:11:55.000Z (4 months ago)
• Last Synced: 2024-10-13T13:44:16.485Z (2 months ago)
• Topics: hacktoberfest
• Language: Rust
• Homepage:
• Size: 73.2 KB
• Stars: 76
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# compact_arena

[![Travis Build Status][travis-badge]][travis-url] [![Docs][doc-badge]][doc-url] [![Current Crates.io Version][crates-badge]][crates-url]

[travis-badge]: https://travis-ci.org/llogiq/compact_arena.svg?branch=master

[travis-url]: https://travis-ci.org/llogiq/compact_arena

[doc-badge]: https://docs.rs/compact_arena/badge.svg

[doc-url]: https://docs.rs/compact_arena

[crates-badge]: https://img.shields.io/crates/v/compact_arena.svg

[crates-url]: https://crates.io/crates/compact_arena

This is a crate with arenas that work with indices. Currently there are three

types: `SmallArena` uses 32-bit indices and can hold up to 2³² objects.

`TinyArena` uses 16-bit indices and can hold up to 65536 objects (only 16384

on windows), regardless of object size. `NanoArena` uses 8-bit indices and

contain up to 256 objects.

This can conserve memory in scenarios where we have a large-ish number of

relations between objects, e.g. in graph algorithms. `NanoArena` is likely

most useful in embedded scenarios.

## Usage:

Add the following dependency to your `Cargo.toml`

```toml

compact_arena = "0.5"

```

By default, the `TinyArena` uses no unsafe code to maintain storage, but

requires the stored types to be `Default + Copy`. To change this, you can use

the `uninit` feature to enable usage on all types with a bit more unsafe code:

```toml

compact_arena = { version = "0.5", features = ["alloc", "uninit"] }

```

In your code, use it as follows:

```rust

use compact_arena::mk_arena;

mk_arena!(arena);

let hello = arena.add("Hello");

let world = arena.add("World");

println!("{}, {}!", arena[hello], arena[world]);

```

For further information, please read the [documentation](https://docs.rs/compact_arena).

# License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally

submitted for inclusion in the work by you, as defined in the Apache-2.0

license, shall be dual licensed as above, without any additional terms or

conditions.