Library reference

Search library APIs

The API reference is generated from public declarations and their --- doc comments in core, hosted and platform. It includes exact signatures, source links, module browsing and local search. The comments also appear in editor hover. The library guide explains the shared conventions and evidence; the tour teaches the language.

core is available on every enabled target. hosted requires a hosted system. Each platform module declares a narrower target scope. Availability does not promise that every composition fits a particular firmware image. All memory and handle lifetimes remain explicit caller obligations.

The examples below are existing compiler fixtures, included directly in the rendered reference so the documentation does not maintain a second copy. Their fixture metadata and target lanes determine where they execute.

core

core/diag — Bounded diagnostic storage and streaming diagnostics through a writer capability.
core/failing — Deterministic allocation-failure injection over any allocator, with cumulative counters.
core/io — Reader, writer, file and process capabilities, their world composition, and an in-memory provider.
core/map — An insertion-ordered hash map, key equality and hash evidence, and explicit entry walks.
core/mem — Memory providers and typed storage: the foundation for allocation, initialized prefixes and caller-owned backing.
core/panic — The four compiler panic atoms and their shared panic-kind domain.
core/pool — A reclaiming allocator over fixed-size slots and caller-supplied bookkeeping.
core/region — An allocator scope that records allocations through a borrowed parent and releases them together.
core/small — A vector that keeps an inline prefix and spills into allocated storage when it fills.
core/sort — Allocation-free in-place heapsort and selection sort using ordering evidence.
core/text — Byte cursors, validated UTF-8 views, byte search and bounded decimal conversion.
core/tree — An append-only store of named leaves and branches addressed by node identifiers.
core/vec — A growable contiguous list with explicit allocation and rollback on failed growth.

hosted

hosted/heap — An explicit allocator over the host runtime heap.
hosted/io — Hosted file, stream and process operations through libc.

platform

platform/c — C scalar aliases selected by the supported LP64 ABI.
platform/cpu — M-profile interrupt masking, waiting and memory barriers.