Expand description
Builder session: the only public mutation path into HIR (AD-13).
Structs§
- Diagnostic
- Diagnostics
- Elaborate
Session - Session token holding the unfrozen circuit (AD-13).
- Frozen
- Immutable circuit after freeze (AD-7).
- Frozen
Hir - Immutable circuit after freeze (AD-7).
- Generated
Instance - Plain instance spec produced by an elaborate-time factory
Fn(FR73 / Cap-R-53). - HirDiagnostics
- HwCapture
Ref - Documented illegal-capture marker for Wire/Reg/signal refs (Story 27.3).
- Legal
Empty Closure - Positive stand-in: empty non-capturing closure (FR74 ATDD).
- Legal
Simple Closure - Positive stand-in: simple pure unary transform (FR74 / FR75 comb inline).
- SeqOwnership
Violation - Documented Cap-R-70 ownership violation token (Story 28.3).
- Span
- Source span threaded from builder / macros (opaque for now).
- Synthesizable
Closure Violation - Documented SynthesizableClosure violation token (Story 28.1 / Cap-R-60).
Enums§
- Comb
Inline - Elaborate-time description of a combinational RHS (FR75 / Cap-R-55).
- Ground
Type - Ground types for phase-1 HIR (AD-12).
- HwCapture
Kind - Kind of hardware reference that must not be captured into elaborate-time generator / factory closures (FR73 / NFR35 / AD-18).
- SeqInline
- Elaborate-time description of a sequential
Reg.dnext-state (FR75 / Cap-R-56). - SeqOwnership
Violation Kind - Cap-R-70 ownership breach inside sequential synthesizable-closure inline.
- Signal
Kind - Synthesizable
Closure Violation Kind - Kind of SynthesizableClosure constraint breach (FR74 / Cap-R-48…50).
Traits§
- Elaboratable
- Trait implemented by
#[rhdl::top]/ design modules (AD-19 partial for 1.1). - Synthesizable
Closure - Documented constraints for closures that may enter the synthesizable hardware path (FR74 / Cap-R-48…50 / AD-18).
Functions§
- diagnose_
seq_ ownership_ violations - Cap-R-70 check surface: diagnose seq-ownership violations without a session.
- diagnose_
synthesizable_ closure_ violations - Cap-R-60 check surface: diagnose SynthesizableClosure violations without a
session (CLI /
cargo bitloom checkcan call this; session methods wrap it). - generate_
mem_ init_ words - Elaborate-time LUT/ROM table builder (FR73). Runs
f(addr)for each address; returns plain words — the closure never enters HIR. - mask_
mem_ word - Mask a mem init word to
widthbits (MVP: width ≤ 64).