Reference
std/arena
std/arena
Values in slots, reached through handles that check the generation of the slot.
narra
import * as Arenas from "std/arena"
The guide teaches it in chapter 13, The standard library.
This page is generated by scripts/std/generate.nra from narrac query --json interface std/arena. Do not edit it.
Types
Handle
narra
export opaque struct Handle<T> derives Equatable, Hashable, Show
Functions: insert, contains, get, set, update, remove, entries.
Arena
narra
export opaque struct Arena<T>
Functions: create, insert, contains, size, get, set, update, remove, clear, entries.
Functions
create
narra
export function create<T>(): Arena<T> uses alloc
Effects: alloc.
insert
narra
export function insert<T>(mutable arena: Arena<T>, value: T): Handle<T> uses alloc
Effects: alloc.
contains
narra
export function contains<T>(arena: Arena<T>, handle: Handle<T>): bool
Effects: none.
size
narra
export function size<T>(arena: Arena<T>): int
Effects: none.
get
narra
export function get<T>(arena: Arena<T>, handle: Handle<T>): Option<T> from arena
Effects: none.
set
narra
export function set<T>(mutable arena: Arena<T>, handle: Handle<T>, value: T): bool
Effects: none.
update
narra
export function update<T, effect E>(mutable arena: Arena<T>, handle: Handle<T>, change: (T) => T uses E): bool uses E
Effects: E.
remove
narra
export function remove<T>(mutable arena: Arena<T>, handle: Handle<T>): Option<T> uses alloc
Effects: alloc.
clear
narra
export function clear<T>(mutable arena: Arena<T>) uses alloc
Effects: alloc.
entries
narra
export function* entries<T>(arena: Arena<T>): Generator<#[Handle<T>, T]>
Effects: none.