API Reference

This reference documents the packages that ship with Rux: every public type, interface, function and constant, what it does and where it lives in the source. It is for looking things up rather than learning — if you are new to the language, start with Learn Rux or the Rux Language Reference.

Rux has no monolithic runtime. Each package below is a dependency a project declares in its manifest, and a program depends only on what it asks for.

Reading this reference

Each package has an overview page listing everything it exports, and each type, interface or function has a page of its own. A type's members — constructors, methods, operators and constants — are sections of that page, so every one has a link of its own, such as /docs/api/allocator/arena#reset.

• Header — the declaration's kind, the package version it describes, and a Source button that opens the declaration on GitHub.
• Sidebar — inside a package, the sidebar lists that package only, grouped into interfaces, types, functions and constants. The menu above it switches to another package.
• Platform badges — Linux, FreeBSD, macOS and Windows each bind one operating system's own entry points, with no portability layer, and build only for that platform. Guard every call to them with conditional compilation.