API Reference

§ 1Hosted rustdoc

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

vihaco

The framework: instructions, messages, effects, components, observers, composites, modules, syntax, runtime.

vihaco-cpu

A ready-made CPU/host component and its instruction set.

vihaco-parser

The #[derive(Parse)] proc-macro.

vihaco-parser-core

The Parse trait and primitive parser impls.

§ 2Build it locally

To generate the same API docs from a checkout:

cargo doc --workspace --no-deps --open

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_core/index.html

For a live local preview of this guide site instead, run npm run 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.