alloc/arena_box

Library guide · API index and notation

This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.

import "alloc/arena_box"

Names used in signatures

Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.

new

Function · Source

Own a value in caller-backed arena storage. The returned Box exclusively borrows its allocator until extraction or destruction. T cannot carry checked borrows or contain Results. Allocation failure destroys value normally.

pub fn new<T>(allocator: &mut arena.Arena, value: T) -> boxed.Box<T, arena.Arena>!error.AllocError from(allocator)