arena-lib 0.1.0

Typed memory arena and slab allocator library. Generational indices, typed arenas (one allocation per type), interned strings, and bump allocation. Zero unsafe leakage into user code.
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

//! # arena-lib
//!
//! TYPED MEMORY ARENAS AND SLAB ALLOCATION
//!
//! Generational indices, typed arenas, interned strings, bump allocation. Zero unsafe leakage into user code.
//!
//! # Status
//!
//! Early scaffolding (v0.1.0). The public API is being designed for the 1.0 release.
//! The crate currently compiles and exposes [`VERSION`] only. See
//! [the repository](https://github.com/jamesgober/arena-lib) for the milestone plan.
//!
//! # License
//!
//! Dual-licensed under Apache-2.0 OR MIT.

#![doc(html_root_url = "https://docs.rs/arena-lib")]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(not(feature = "std"), no_std)]
#![deny(missing_docs)]
#![deny(unsafe_op_in_unsafe_fn)]
#![deny(unused_must_use)]
#![deny(unused_results)]
#![deny(clippy::unwrap_used)]
#![deny(clippy::expect_used)]
#![deny(clippy::todo)]
#![deny(clippy::unimplemented)]
#![deny(clippy::print_stdout)]
#![deny(clippy::print_stderr)]
#![deny(clippy::dbg_macro)]
#![deny(clippy::undocumented_unsafe_blocks)]
#![deny(clippy::missing_safety_doc)]

/// Crate version string, populated by Cargo at build time.
///
/// Matches the `version` field in `Cargo.toml` exactly. Useful for diagnostics,
/// telemetry, and `--version` output in tools that embed `arena-lib`.
///
/// # Examples
///
/// ```
/// use arena_lib::VERSION;
///
/// assert!(!VERSION.is_empty());
/// assert!(VERSION.chars().next().is_some_and(|c| c.is_ascii_digit()));
/// ```
pub const VERSION: &str = env!("CARGO_PKG_VERSION");