Expand description
Fast and flexible arena-based bump allocator.
multitude is an arena-based bump allocator designed to improve the performance of applications that have phase-oriented logic, which
is when groups of related allocations live and die together. Service request handling and parsers are two examples of this pattern which usually
benefit from a bump allocator.
multitude works by accumulating large chunks of memory allocated from the system and then carving out smaller pieces of it for application use
using a fast bump allocation strategy, which is considerably faster than allocating from the system. The downside however is that the individual allocations
can’t be freed separately. Instead, memory is reclaimed and returned to the system in bulk when the entire arena is dropped.
§Why Another Bump Allocator?
The Rust ecosystem has a few bump allocators, the most popular being bumpalo.
multitude uses a different implementation strategy and has a richer API surface making it suitable for more
use cases. The main features that set multitude apart are:
-
Flexibility. Four allocation styles coexist in the same arena: the arena-lifetime owning handle
Alloc<T>plus three escape-capable smart pointers — the atomicArc, the non-atomic single-threadRc, and the unique-ownerBox— each available for sizedT,str, and[T]. See the comparison table for how they differ. -
Early Reclamation. In many situations,
multitudecan reclaim memory from individual chunks as soon as their reference counts drop to zero, without waiting for the entire arena to be dropped. This allows for more efficient memory usage in long-running arenas with many short-lived allocations. -
Smart Pointers Can Outlive the Arena. Some of the smart pointers produced by
multitudecan keep their owning chunk alive even after the arena itself has been dropped, allowing for more flexible memory management and longer-lived data structures. -
Drop Support.
multitudeautomatically runsDropfor allocated values at the appropriate time. -
Uniformly Thin Smart Pointers.
multitude’s escape-capable smart pointers —Arc<T>,Rc<T>, andBox<T>— are 8 bytes on 64-bit for everyT, even DSTs likestrand[T](the metadata lives in a chunk prefix). The arena-lifetimeAlloc<T>handle is a single word for sizedT; forstr/[T]it is a fat reference (pointer + length), which costs nothing extra since it never escapes the arena and isn’t stored at scale. -
Efficient Mutable Strings and Vectors.
multitudeprovidesString,Utf16StringandVecwhich are growable collections that live in the arena. -
Dynamically-Sized Types.
multitudesupports dynamically-sized types (DSTs) like slices and strings, allowing you to allocate and manage them in the arena with the same flexibility as sized types. Thedst-factorycrate is a great companion for building DSTs in the arena. -
format!-style Macro.multitudeincludes aformat!-style macro that allows you to create formatted strings directly in the arena, avoiding intermediate allocations and copies. -
UTF-16 Support. With the
utf16Cargo feature,multitudeprovides a parallel set of arena-resident UTF-16 string types (Arc<Utf16Str>,Box<Utf16Str>,Utf16String) and aformat_utf16!macro for FFI / Windows / JS-engine interop without per-call transcoding at every boundary. -
#![no_std]Support.multitudecan be used in#![no_std]environments, making it suitable for embedded systems and other resource-constrained contexts.
See BUMPALO.md
for a feature-by-feature comparison with bumpalo.
§Example
use multitude::Arena;
let arena = Arena::new();
// Cheap atomic reference-counted allocation of any user type.
struct Point { x: f64, y: f64 }
let p = arena.alloc_arc(Point { x: 3.0, y: 4.0 });
let p2 = p.clone();
assert_eq!(p.x, p2.x);
// Single-pointer immutable strings.
let name = arena.alloc_str_arc("Alice");
assert_eq!(&*name, "Alice");
// format! macro returning a String.
let greeting = multitude::strings::format!(in &arena, "Hello, {}!", "world");
assert_eq!(&*greeting, "Hello, world!");§Flexibility
multitude offers four ways to allocate a value and own it over time. All
four can coexist in the same arena, dereference to the value, and run
T::drop eagerly; they differ in whether the handle can outlive the
arena, whether ownership is unique or shared, and what (if any) per-handle
reference count they pay. Each is available for sized T, str, and [T]
(and, behind the dst feature, arbitrary DSTs).
Alloc<T> | Box<T> | Rc<T> | Arc<T> | |
|---|---|---|---|---|
| Constructor family | alloc | alloc_box | alloc_rc | alloc_arc |
| Ownership | unique | unique | shared (Clone) | shared (Clone) |
&mut T access | ✅ | ✅ | ❌ | ❌ |
| Can outlive the arena | ❌ | ✅ | ✅ | ✅ |
| Per-handle reference count | none | none | non-atomic | atomic |
| Cross-thread sharing | ❌ | ❌ | ❌ (!Send) | ✅ (T: Send + Sync) |
| Width (64-bit) | 1 word (sized); fat ref for DSTs | 8 bytes | 8 bytes | 8 bytes |
The cheapest option is Alloc<T>: an owning handle whose lifetime
is tied to the arena — a single word for sized T (a fat pointer+length
reference for str / [T]). It pays no reference count and cannot
outlive the arena, but gives mutable access and runs the destructor when it
is dropped — the fastest way to allocate when the lifetime constraint is
tolerable.
let arena = multitude::Arena::new();
let mut x = arena.alloc(42);
*x += 1;
assert_eq!(*x, 43);
// Strings and slices too:
let s = arena.alloc_str("hello");
let v = arena.alloc_slice_copy(&[1, 2, 3]);
assert_eq!(&*s, "hello");
assert_eq!(&*v, &[1, 2, 3]);For values that must outlive the arena, use one of the three smart
pointers. They behave like the like-named std types but are uniformly
8-byte thin pointers (even for DSTs) addressing storage inside a chunk,
and they keep that chunk alive until the last handle drops.
Arc is reference-counted and shareable across threads:
use multitude::Arc;
let p: Arc<u32> = {
let arena = multitude::Arena::new();
arena.alloc_arc(42)
// arena dropped here; `p` keeps its chunk alive
};
assert_eq!(*p, 42);
let arena = multitude::Arena::new();
let shared = arena.alloc_arc(7_u64);
let h = std::thread::spawn(move || *shared);
assert_eq!(7, h.join().unwrap());Rc is the cheaper single-thread sibling of Arc: its reference count
is non-atomic, so clone/drop are cheaper and str / [u8] pack slightly
tighter. Being !Send/!Sync, it places no Send/Sync
bound on T, so it can share thread-affine values (e.g. Rc<RefCell<T>>)
that Arc cannot.
use multitude::Rc;
let arena = multitude::Arena::new();
let a: Rc<u64> = arena.alloc_rc(42);
let b = a.clone();
assert_eq!(*a, *b);Box is a unique owner that provides &mut T access, like
alloc::boxed::Box but backed by the arena:
let arena = multitude::Arena::new();
let mut v = arena.alloc_box(vec![1, 2, 3]);
v.push(4);
assert_eq!(*v, vec![1, 2, 3, 4]);
drop(v); // The vec drop runs here, freeing its heap buffer.Although Arena itself is !Sync, it is Send: an arena — along with
any in-flight Alloc handles and smart pointers — can be moved between
threads. For cross-thread sharing of an individual value, allocate an
Arc and .clone() it across threads.
§Collections
Vec, String, and Utf16String are growable collections that live in
the arena.
Additionally, you can use an arena as
the allocator for any type from the allocator-api2 ecosystem
(including hashbrown::HashMap).
use multitude::Arena;
use multitude::vec::{CollectIn, Vec};
let arena = Arena::new();
let mut v = arena.alloc_vec::<i32>();
for i in 0..5 {
v.push(i);
}
// CollectIn trait for iterator collection.
let squares: Vec<i32, _> = (1..=5).map(|i| i * i).collect_in(&arena);
assert_eq!(squares.as_slice(), &[1, 4, 9, 16, 25]);§Freezing
String and Vec are designed as transient
builders — mutable, growable handles meant to be used briefly and then frozen.
Once you’re done building, you can freeze them into immutable smart pointers:
String::into_boxed_str→Box<str>(8 bytes, thin), orBox::from(string). The freeze is O(n) — it copies the bytes into a compact allocation that can outlive the arena. (Like anyBox, it isSend/Synconly when the allocatorAis.)Vec::into_boxed_slice→Box<[T]>(8 bytes, thin), orBox::from(vec). The freeze is O(n) — it moves the elements into a fresh compact allocation that can outlive the arena. (Like anyBox, it isSend/Synconly whenTand the allocatorAare.)Arc::from(vec)/Arc::from(string)→Arc<[T]>/Arc<str>, the shared, reference-counted freeze (mirroringstd’sFrom<Vec<T>> for Arc<[T]>).Vec::leak→&mut [T](or&*v.leak()for&[T]) borrowed for the arena’s lifetime. ForT: !Drop, this freeze is O(1) and allocation-free — the existing buffer is reinterpreted in place. Unlike theBox/Arcfreezes, the slice does not outlive the arena.
The Vec freeze also reclaims any unused capacity left in the
buffer when the conditions allow it, so those bytes become available
for the next allocation.
use multitude::{Arena, Box};
let arena = Arena::new();
// Build phase: 32-byte builder, alive briefly.
let mut builder = arena.alloc_string();
builder.push_str("hello, ");
builder.push_str("world");
// Freeze for storage: 8-byte single-pointer smart pointer. O(n) — copies the bytes.
let stored: Box<str> = builder.into_boxed_str();
assert_eq!(&*stored, "hello, world");Use this pattern whenever you’d be storing many strings or slices long-term — the per-pointer savings (8 bytes for both strings and slices) add up quickly across millions of items.
§Maps and Sets
With the hashbrown Cargo feature, Arena can directly back
hashbrown collections via
Arena::alloc_hash_map, Arena::alloc_hash_map_with_capacity,
Arena::alloc_set, and Arena::alloc_set_with_capacity. The returned
HashMap / HashSet store their entries in arena chunks.
use multitude::Arena;
let arena = Arena::new();
let mut map = arena.alloc_hash_map::<u32, &str>();
map.insert(1, "one");
assert_eq!(map.get(&1), Some(&"one"));
let mut set = arena.alloc_set::<u32>();
set.insert(7);
assert!(set.contains(&7));§Strings
multitude provides a family of arena-resident string types in the
strings module. The model is the same one used for arbitrary
values elsewhere in the crate — bump-allocation backed by a per-chunk
refcount — but specialized for UTF-8 / UTF-16 text and a compact
single-pointer representation.
There are two roles a string type can play:
-
Smart pointers (immutable / owned). Compact handles to string data already stored in the arena. They use a single-pointer (8 bytes on 64-bit) layout — half the size of
&str. They differ in how sharing and mutability work:UTF-8 UTF-16 Sharing Mutable Notes Arc<str>Arc<Utf16Str>atomic refcount; Clone,Send + Syncno cross-thread sharing Box<str>Box<Utf16Str>unique owner; Send + Sync(notClone)yes drops eagerly Like the other arena smart pointers, they keep their owning chunk alive via a refcount, so they can outlive the
Arenathey came from. -
Builders (mutable, growable).
StringandUtf16Stringare transient growable buffers — small structs (32 bytes) carrying a data pointer + length + capacity + arena reference. You build them up withpush_str/push/format!/format_utf16!, then freeze them into one of the smart pointers above:Builder Freeze method Result Stringinto_boxed_strBox<str>Utf16Stringinto_boxed_utf16_strBox<Utf16Str>The UTF-16 freeze reuses the buffer in place (O(1)) and reclaims any unused capacity when it can. The UTF-8 freeze copies the bytes (O(n)) into a compact allocation, so
Box<str>stays a single,Send-safe pointer.
UTF-16 support requires the utf16 Cargo feature. Strict (validated)
UTF-16 only — lone surrogates are rejected. The UTF-16 types
interoperate with widestring::Utf16Str / widestring::Utf16String
for I/O and FFI bridging. UTF-16 length and capacity are counted in
u16 elements (matching widestring::Utf16Str::len()).
§Example: UTF-8
use multitude::Arena;
use multitude::Box;
let arena = Arena::new();
// Single-pointer immutable strings.
let s = arena.alloc_str_arc("hello, world");
assert_eq!(&*s, "hello, world");
// Build incrementally and freeze:
let mut b = arena.alloc_string();
b.push_str("abc");
b.push_str("123");
let frozen: Box<str> = b.into_boxed_str();
assert_eq!(&*frozen, "abc123");
// format!-style:
let name = "Alice";
let greeting = multitude::strings::format!(in &arena, "Hello, {name}!");
assert_eq!(&*greeting, "Hello, Alice!");§Example: UTF-16
use multitude::Arena;
use widestring::utf16str;
let arena = Arena::new();
// From a validated &Utf16Str literal:
let s = arena.alloc_utf16_str_arc(utf16str!("hello, world"));
assert_eq!(&*s, utf16str!("hello, world"));
// Or transcode from a &str:
let s2 = arena.alloc_utf16_str_arc_from_str("hello");
assert_eq!(&*s2, utf16str!("hello"));
// Build incrementally and freeze:
let mut b = arena.alloc_utf16_string();
b.push_str(utf16str!("abc"));
b.push_from_str("123");
let frozen = b.into_boxed_utf16_str();
assert_eq!(&*frozen, utf16str!("abc123"));
// format!-style:
let name = "Alice";
let greeting = multitude::strings::format_utf16!(in &arena, "Hello, {name}!");
assert_eq!(greeting.as_utf16_str(), utf16str!("Hello, Alice!"));§Building DSTs
With the dst Cargo feature enabled, Arena exposes
Arena::alloc_dst_arc and
Arena::alloc_dst_box (and their try_* siblings) for
constructing values whose layout is only known at runtime (custom
DSTs, fat pointers, trait objects).
Each of these takes a Layout, a
pointer-metadata value (e.g. a slice length, a DynMetadata), and
a closure that initializes the buffer through a typed fat pointer.
For most users, the dst-factory companion crate is the
recommended high-level driver; the low-level interface looks like:
use core::alloc::Layout;
use multitude::Arena;
let arena = Arena::new();
// Allocate a 5-byte slice in the arena as a `Box<[u8]>`.
let layout = Layout::array::<u8>(5).unwrap();
let b: multitude::Box<[u8]> = unsafe {
arena.alloc_dst_box::<[u8]>(layout, 5, |fat: *mut [u8]| {
let p = fat.cast::<u8>();
for i in 0..5 {
p.add(i).write(i as u8);
}
})
};
assert_eq!(&*b, &[0, 1, 2, 3, 4]);The same feature also enables eight Arena::alloc_slice_*_box
methods that produce Box<[T]> directly (mirroring the
existing _arc slice methods).
§Crate Features
| Feature | Description |
|---|---|
std (default) | Enables std::io::Write on Vec<u8> for use with write!, std::io::copy, serde_json::to_writer, and similar. Disable for #![no_std] environments (the crate still requires alloc). |
stats | Enables runtime instrumentation counters returned by Arena::stats. Disable for the tightest allocation throughput when you don’t need observability. |
serde | Adds Serialize impls for Arc<str>, Box<str>, String, and Vec. With serde + utf16, also adds impls for the UTF-16 types (transcoded to UTF-8 on the wire). |
dst | Enables the dst module for constructing true dynamically-sized types and trait objects in the arena via Arena::alloc_dst_arc / Arena::alloc_dst_box, plus eight Arena::alloc_slice_*_box methods. |
utf16 | Adds a parallel UTF-16 string surface (Arc<Utf16Str>, Box<Utf16Str>, Utf16String, and format_utf16!) backed by the widestring crate. Lengths are counted in u16 elements. |
zerocopy | Provides ZerocopyView for safe zero-initialized allocation of types implementing zerocopy::FromZeros. Access via Arena::zerocopy(). |
bytemuck | Provides BytemuckView for safe zero-initialized allocation of types implementing bytemuck::Zeroable. Access via Arena::bytemuck(). |
bytes | Adds From conversions from Arc<[u8]> and Arc<str> into bytes::Bytes, enabling zero-copy integration with the Tokio / Hyper async ecosystem. |
bytesbuf | Implements bytesbuf::mem::Memory directly on Arena, so that BytesBuf buffers can be backed by arena chunks. Implies std. |
hashbrown | Lets Arena back hashbrown collections via Arena::alloc_hash_map, Arena::alloc_hash_map_with_capacity, Arena::alloc_set, and Arena::alloc_set_with_capacity. (&Arena always implements the allocator-api2 0.2 Allocator trait so it can back hashbrown directly; this feature adds the convenience constructors.) |
Modules§
- bytemuck
bytemuck - Safe zero-initialized arena allocations for
bytemuck::Zeroabletypes. - dst
dst - Helpers for building dynamically sized arena values.
- strings
- Arena-backed string builders.
- vec
- Arena-backed growable vectors and the
vec!macro. - zerocopy
zerocopy - Safe zero-initialized arena allocations for
zerocopy::FromZerostypes.
Structs§
- Alloc
- An owning handle to a value in an
Arena, with a lifetime tied to that arena. - Arc
- A thread-safe reference-counted smart pointer to a
Tstored in anArena. - Arena
- A flexible bump allocator.
- Arena
Builder - Fluent builder for
Arena. - Arena
Stats stats - Runtime statistics for an
Arena. - Box
- An owned, mutable smart pointer to a
Tstored in anArena. - Rc
- A single-thread, non-atomic reference-counted smart pointer to a
Tstored in anArena.