vox-arch-check API Reference (generated)
Crate: vox-arch-check · Version: 0.6.0 · Target: Library (lib.rs)
CI guard: enforces the workspace layered-architecture model. See docs/src/architecture/2026-05-08-workspace-reorg-design.md.
Crate Overview
Section titled “Crate Overview”Library surface for vox-arch-check.
The crate is primarily a binary (src/main.rs enforces the layered
architecture model). This thin library exposes the pieces that are reused
by the binary AND exercised directly by integration tests — currently the
CR-META criteria-format lint.
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-rename-registry | Development |
vox-test-harness | Development |
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
criteria_format | — |
Dependency Topology
Section titled “Dependency Topology”Diagram source
graph { direction: right node vox_arch_check: "vox-arch-check" node vox_rename_registry: "vox-rename-registry" vox_arch_check -> vox_rename_registry node vox_test_harness: "vox-test-harness" vox_arch_check -> vox_test_harness}Deep Public Symbols (Source-Anchored)
Section titled “Deep Public Symbols (Source-Anchored)”| Kind | Symbol | Signature | Source | Description |
|---|---|---|---|---|
fn | criteria_format::check_criteria_format | pub fn check_criteria_format(doc: &str) -> Result<(), Vec<String>> | crates/vox-arch-check/src/criteria_format.rs#L7-L25 | Returns Ok(()) when every criterion block is well-formed, else the list of human-readable violations. |