stdlib/arenaView source ↗
arena
25 items · generated by scribe fromstdlib/arena.fd· synced 2026-11-15
Contents
- arena_new (function)
- arena_alloc (function)
- arena_save (function)
- arena_restore (function)
- arena_free (function)
- region_new (function)
- region_alloc (function)
- region_free (function)
- region_free_one (function)
- with_arena (function)
- mem_copy (function)
- mem_zero (function)
- mem_set (function)
- arena_used (function)
- region_count (function)
- frame_new (function)
- frame_begin (function)
- frame_alloc (function)
- frame_end (function)
- frame_free (function)
- frame_alloc_count (function)
- http_request_arena_new (function)
- http_request_alloc (function)
- http_request_arena_free (function)
arena_new
Create a new arena. Returns an arena handle (mark for restore). The arena is process-global — all arenas share the same bump allocator. Use arena_save/arena_restore to manage scopes within the arena.
pub fn arena_new() -> i64 {Returns: i64
Defined at line 45
arena_alloc
Allocate size bytes from the arena. Returns a raw pointer (i64). The memory is uninitialized. O(1) — just bumps a pointer. The memory is freed when the arena is restored or freed.
pub fn arena_alloc(arena_mark: i64, size: i64) -> i64 {Parameters:
arena_mark:i64size:i64
Returns: i64
Defined at line 52
arena_save
Save the current arena position. Returns a mark that can be passed to arena_restore to free everything allocated after this point.
pub fn arena_save() -> i64 {Returns: i64
Defined at line 60
arena_restore
Restore the arena to a previously saved mark. Frees all memory allocated after the mark was taken. O(1) — just resets the bump pointer.
pub fn arena_restore(mark: i64) -> void {Parameters:
mark:i64
Returns: void
Defined at line 67
arena_free
Free the entire arena. Equivalent to arena_restore(0). After this, all pointers obtained from arena_alloc are invalid.
pub fn arena_free(arena_mark: i64) -> void {Parameters:
arena_mark:i64
Returns: void
Defined at line 73
region_new
Region header — tracks a linked list of allocations. Stored as a Vec of pointers for simplicity. The region itself is heap-allocated. Create a new region. Returns a pointer to the region header. Use region_alloc to allocate within the region. Use region_free to free all allocations in the region.
pub fn region_new() -> i64 {Returns: i64
Defined at line 93
region_alloc
Allocate size bytes within a region. Returns a raw pointer. The memory is freed when region_free is called.
pub fn region_alloc(region: i64, size: i64) -> i64 {Parameters:
region:i64size:i64
Returns: i64
Defined at line 105
region_free
Free all allocations in a region. O(n) where n is the number of allocations, but typically called once at scope exit.
pub fn region_free(region: i64) -> void {Parameters:
region:i64
Returns: void
Defined at line 113
region_free_one
Free a single allocation within a region. This is a no-op for arena-based regions (individual frees aren’t supported). For linked-list regions, this removes the allocation from the list and frees it.
pub fn region_free_one(region: i64, ptr: i64) -> void {Parameters:
region:i64ptr:i64
Returns: void
Defined at line 120
with_arena
Run a function with a fresh arena, then free the arena. All allocations made within the function via arena_alloc are automatically freed when the function returns.
Example: with_arena(fn() -> i64 { var p = arena_alloc(0, 64); // … use p … return 0; });
pub fn with_arena(f: fn() -> i64) -> i64 {Parameters:
f:fn() -> i64
Returns: i64
Defined at line 140
mem_copy
Copy n bytes from src to dst. Both must be valid pointers. Regions: src and dst can be in any region or the heap.
pub fn mem_copy(dst: i64, src: i64, n: i64) -> void {Parameters:
dst:i64src:i64n:i64
Returns: void
Defined at line 151
mem_zero
Fill n bytes at dst with zero. Useful for initializing allocated memory.
pub fn mem_zero(dst: i64, n: i64) -> void {Parameters:
dst:i64n:i64
Returns: void
Defined at line 164
mem_set
Fill n bytes at dst with byte val.
pub fn mem_set(dst: i64, val: i64, n: i64) -> void {Parameters:
dst:i64val:i64n:i64
Returns: void
Defined at line 169
arena_used
Get the total number of bytes allocated in the arena. This is the current bump pointer offset.
pub fn arena_used() -> i64 {Returns: i64
Defined at line 177
region_count
Get the number of allocations in a region. For arena-based regions, this is not tracked.
pub fn region_count(region: i64) -> i64 {Parameters:
region:i64
Returns: i64
Defined at line 186
frame_new
Create a new frame allocator. Returns a FrameArena with mark=0. Call frame_begin at the start of each iteration, frame_end at the end.
pub fn frame_new() -> FrameArena {Returns: FrameArena
Defined at line 219
frame_begin
Begin a new frame. Saves the current arena position. All allocations between frame_begin and frame_end will be freed when frame_end is called.
pub fn frame_begin(fa: & mut FrameArena) -> void {Parameters:
fa:& mut FrameArena
Returns: void
Defined at line 228
frame_alloc
Allocate size bytes within the current frame. The memory is freed when frame_end is called. Must be called between frame_begin and frame_end.
pub fn frame_alloc(fa: & mut FrameArena, size: i64) -> i64 {Parameters:
fa:& mut FrameArenasize:i64
Returns: i64
Defined at line 236
frame_end
End the current frame. Frees all memory allocated since frame_begin. The backing memory is reused for the next frame (no actual free — just resets the bump pointer).
pub fn frame_end(fa: FrameArena) -> void {Parameters:
fa:FrameArena
Returns: void
Defined at line 244
frame_free
Free the frame allocator’s backing memory. Call this when you’re done with the frame allocator (e.g. when the game loop exits).
pub fn frame_free(fa: FrameArena) -> void {Parameters:
fa:FrameArena
Returns: void
Defined at line 251
frame_alloc_count
Get the number of allocations in the current frame.
pub fn frame_alloc_count(fa: FrameArena) -> i64 {Parameters:
fa:FrameArena
Returns: i64
Defined at line 256
http_request_arena_new
Create a new HTTP request arena. Returns a mark for later restore. All allocations made via http_request_alloc will be freed when http_request_arena_free is called.
pub fn http_request_arena_new() -> http_request_arena {Returns: http_request_arena
Defined at line 284
http_request_alloc
Allocate size bytes within an HTTP request arena. The memory is freed when http_request_arena_free is called.
pub fn http_request_alloc(arena: http_request_arena, size: i64) -> i64 {Parameters:
arena:http_request_arenasize:i64
Returns: i64
Defined at line 290
http_request_arena_free
Free an HTTP request arena. All allocations made via http_request_alloc are freed at once. Call this after the response has been sent.
pub fn http_request_arena_free(arena: http_request_arena) -> void {Parameters:
arena:http_request_arena
Returns: void
Defined at line 296
Generated by scribe, the Fides documentation generator