Expand description
Stable, source-language-independent authoring API for Celox frontends.
This crate deliberately does not depend on Celox compiler internals. A
frontend parses and elaborates its input, constructs a FrontendArtifact,
and hands that artifact to the public celox compiler API.
Structs§
- Assignment
- One continuous/combinational assignment.
- Async
Reset - Optional asynchronous reset configuration for a storage element.
- Constant
- Constant payload and four-state mask. Set mask bits represent X/Z.
- Enable
- Optional synchronous enable configuration for a storage element.
- ExprId
- Identity of one expression in the elaborated module.
- Expression
- Typed expression entry.
- Frontend
Artifact - Fully elaborated frontend result. The first SDK version intentionally models one flattened module; hierarchical netlists can be flattened by the producing frontend without affecting runtime signal names.
- Module
Builder - Builder for one flattened, elaborated netlist module.
- Register
- One edge-triggered storage element in an elaborated netlist.
- Signal
- One declared signal retained for runtime reflection and TypeScript access.
- Signal
Id - Identity of one signal in the elaborated module.
- Signal
Slice - A fixed bit range of a signal.
- Value
Type - Source-independent bit-vector type.
Enums§
- Active
Level - Active level of a reset or enable signal.
- Artifact
Json Error - JSON interchange failures for frontend artifacts.
- Binary
Op - Binary operation in the frontend expression vocabulary.
- Build
Error - Errors detected while constructing a frontend artifact.
- Direction
- Public direction of a signal.
- Edge
- Edge polarity used by clocked storage.
- Expr
Node - One expression node. Node result types are explicit so a netlist frontend does not inherit source-language width inference rules from Celox.
- UnaryOp
- Unary operation in the frontend expression vocabulary.
Constants§
- ARTIFACT_
FORMAT_ VERSION - Current JSON interchange version of
FrontendArtifact.