vox-cli-contracts API Reference (generated)
Crate: vox-cli-contracts · Version: 0.6.0 · Target: Library (lib.rs)
Trait seam between vox-cli (provides impls) and vox-cli-ci (consumes them), plus shared check-manifest types. Sync, no tokio — keep the floor low.
Crate Overview
Section titled “Crate Overview”Trait seam that inverts vox-cli’s CI coupling: vox-cli implements these traits
(VoxCliProviders) and vox-cli-ci consumes them, so the CI subsystem can move out
without depending back on vox-cli. Also home to the shared check-manifest types.
Keep this crate’s code sync — it uses no async runtime directly, so it stays a
cheap leaf to compile. (The cargo tree -i tokio graph is not empty because the
workspace-hack feature-unification crate pulls tokio into every member’s tree; that
is a graph artifact, not a real dependency of this crate’s own compilation.)
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-bounded-fs | Normal |
vox-config | Normal |
vox-jsonschema-util | Normal |
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
scientia_ledger_contract | Finding-candidate / novelty-bundle schema validation (vox scientia + the ci scientia-ledger gate). Lives here because it is shared by a non-ci command and ci. |
Structs
Section titled “Structs”| Struct | Description |
|---|---|
CheckManifest | Top-level structure of contracts/ci/check-targets.v1.yaml. |
CheckEntry | One quality-gate entry in the manifest. |
Traits
Section titled “Traits”| Trait | Description |
|---|---|
CheckProvider | Audit seam: enumerate contracts/ci/check-targets.v1.yaml into policy entries. Replaces ci’s direct crate::commands::audit::CheckManifest deserialization. |
GateStatusWriter | Policy seam: write gate-run status (VCS identity + results). ran_at stays caller-supplied — the single non-deterministic input, kept out of the impl. |
TerminalPolicyValidator | Runtime seam: terminal-policy validation for vox ci. The check_terminal primitives stay in vox-cli behind this impl; the orchestration moves to vox-cli-ci. |
Dependency Topology
Section titled “Dependency Topology”Diagram source
graph { direction: right node vox_cli_contracts: "vox-cli-contracts" node vox_bounded_fs: "vox-bounded-fs" vox_cli_contracts -> vox_bounded_fs node vox_config: "vox-config" vox_cli_contracts -> vox_config node vox_jsonschema_util: "vox-jsonschema-util" vox_cli_contracts -> vox_jsonschema_util node vox_cli: "vox-cli" vox_cli -> vox_cli_contracts node vox_cli_ci: "vox-cli-ci" vox_cli_ci -> vox_cli_contracts node vox_cli_research: "vox-cli-research" vox_cli_research -> vox_cli_contracts}Reverse Dependents (Used By)
Section titled “Reverse Dependents (Used By)”| Consumer Crate | Role |
|---|---|
vox-cli | Direct workspace dependent |
vox-cli-ci | Direct workspace dependent |
vox-cli-research | Direct workspace dependent |
Deep Public Symbols (Source-Anchored)
Section titled “Deep Public Symbols (Source-Anchored)”| Kind | Symbol | Signature | Source | Description |
|---|---|---|---|---|
struct | CheckManifest | pub struct CheckManifest | crates/vox-cli-contracts/src/lib.rs#L24-L27 | Top-level structure of contracts/ci/check-targets.v1.yaml. |
struct | CheckEntry | pub struct CheckEntry | crates/vox-cli-contracts/src/lib.rs#L31-L43 | One quality-gate entry in the manifest. |
trait | CheckProvider | pub trait CheckProvider | crates/vox-cli-contracts/src/lib.rs#L51-L53 | Audit seam: enumerate contracts/ci/check-targets.v1.yaml into policy entries. Replaces ci’s direct crate::commands::audit::CheckManifest deserialization. |
trait | GateStatusWriter | pub trait GateStatusWriter | crates/vox-cli-contracts/src/lib.rs#L57-L68 | Policy seam: write gate-run status (VCS identity + results). ran_at stays caller-supplied — the single non-deterministic input, kept out of the impl. |
trait | TerminalPolicyValidator | pub trait TerminalPolicyValidator | crates/vox-cli-contracts/src/lib.rs#L72-L76 | Runtime seam: terminal-policy validation for vox ci. The check_terminal primitives stay in vox-cli behind this impl; the orchestration moves to vox-cli-ci. |
fn | scientia_ledger_contract::validate_finding_candidate_file | pub fn validate_finding_candidate_file(repo_root: &Path, json_path: &Path) -> Result<()> | crates/vox-cli-contracts/src/scientia_ledger_contract.rs#L59-L66 | Validate a finding-candidate JSON file against finding-candidate.v1.schema.json. |
fn | scientia_ledger_contract::validate_novelty_bundle_file | pub fn validate_novelty_bundle_file(repo_root: &Path, json_path: &Path) -> Result<()> | crates/vox-cli-contracts/src/scientia_ledger_contract.rs#L69-L76 | Validate a novelty-evidence-bundle JSON file against novelty-evidence-bundle.v1.schema.json. |
fn | scientia_ledger_contract::example_finding_candidate_path | pub fn example_finding_candidate_path(repo_root: &Path) -> PathBuf | crates/vox-cli-contracts/src/scientia_ledger_contract.rs#L79-L81 | Default example paths (repo-relative) exercised by vox ci scientia-novelty-ledger-contracts. |
fn | scientia_ledger_contract::example_novelty_bundle_path | pub fn example_novelty_bundle_path(repo_root: &Path) -> PathBuf | crates/vox-cli-contracts/src/scientia_ledger_contract.rs#L83-L85 | — |