Reference

API Reference

This site is the guide-style documentation. The full Rust API reference is the generated rustdoc for the workspace crates.

§ 1Hosted rustdoc

The generated rustdoc is published alongside this site under the rust-api/ path. Entry points:

vihaco: The framework: instructions, messages, effects, components, composites, modules, syntax, runtime.
vihaco-cpu: A ready-made CPU/host component and its instruction set.
vihaco-stdlib: ExecutionState, Image, Loadable, and the program dialect.
vihaco-runtime: Dispatch, Step, BuildMessage, Execute, Apply, and field routing.
vihaco-module: LocalModule, ProgramMetadata, and lowering capabilities.
vihaco-syntax: Parsed modules, header declarations, and function lowering.
vihaco-parser: The Parse trait plus lexical, primitive, and collection parsers.
vihaco-parser-derive: The #[derive(Parse)] proc-macro.

§ 2Build it locally

To generate the same API docs from a checkout:

cargo doc --no-deps --features vihaco/program-image-execution \
  -p vihaco -p vihaco-cpu -p vihaco-stdlib -p vihaco-runtime \
  -p vihaco-module -p vihaco-syntax -p vihaco-parser -p vihaco-parser-derive

Common entry points in the generated output:

target/doc/vihaco/index.html
target/doc/vihaco_cpu/index.html
target/doc/vihaco_parser/index.html
target/doc/vihaco_parser_derive/index.html

For a live local preview of this guide site instead, run pnpm dev in docs/.

§ 3Looking for the concepts?

The rustdoc documents every type and method. To learn how the pieces fit together — instruction encoding, the message/effect data flow, the parser pipeline, composing a machine — start with the Guides.