Module api

Module api 

Source
Expand description

Public API for framealloc.

This module contains all user-facing types and functions. Most users should only interact with types from this module.

Modulesยง

alloc
The main allocator type.
barrier
Frame barriers for deterministic multi-thread synchronization.
checkpoint
Frame checkpoints - save and restore points within a frame.
config
Allocator configuration.
deferred_control
Deferred processing control for v0.6.0.
frame_collections
Frame-local collections - bounded collections that live for a frame.
groups
Allocation groups - named collections of allocations that can be freed together.
lifecycle
Frame lifecycle events for v0.6.0 observability.
phases
Frame phases - named scopes within a frame for better diagnostics and profiling.
promotion
Promotion logic - handles moving allocations from frame to other allocators.
retention
Frame retention policies - control what happens to allocations at frame end.
scope
Frame scope guards for RAII-style frame management.
scratch
Scratch pools - cross-frame reusable memory pools.
snapshot
Snapshot emission for IDE integration (v0.7.0).
stats
Allocation statistics.
tag
Allocation intent tags.
tagged
First-class allocation tags - ergonomic tag-scoped allocations.
thread_budget
Per-thread frame budgets for v0.6.0.
transfer
Explicit cross-thread transfer handles for v0.6.0.
wrappers
Safe wrapper types for allocations.