Guides

These guides explain how to build on top of vihaco: how to define an instruction set, parse source text into it, resolve execution input, execute components, observe their effects, and compose everything into a machine.

For the type-by-type API reference, see the generated rustdoc.

Recommended reading order

1. Defining Instructions With vihaco Start with instruction enums and width inference.
   • Advanced Instruction Usage Explicit opcodes, explicit widths, and machine-level wrapper instructions.
2. Pattern Parser Integration for Component Instructions The Parse trait, syntax classes, and declarative instruction patterns.
   • Pattern Parser Compile-time-checked patterns for instruction, value, and type enums and structs.
   • Module Parsing and Resolution Module-level parsing: device headers, typed function bodies, Resolve implementations, and component section routing.
3. Using Messages With vihaco How a runtime resolves execution input and supplies messages to components.
4. Building Components With vihaco Declare instruction products with component! and implement Execute<I>.
5. Observing Effects With Observe Borrow effects for diagnostics while a route sends ownership to one handler.
6. Defining A Composite With vihaco Compose components with composite! routes, message sources, and handlers.