Skip to content

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.

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.)

DependencyKind
vox-bounded-fsNormal
vox-configNormal
vox-jsonschema-utilNormal
ModuleDescription
scientia_ledger_contractFinding-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.
StructDescription
CheckManifestTop-level structure of contracts/ci/check-targets.v1.yaml.
CheckEntryOne quality-gate entry in the manifest.
TraitDescription
CheckProviderAudit seam: enumerate contracts/ci/check-targets.v1.yaml into policy entries. Replaces ci’s direct crate::commands::audit::CheckManifest deserialization.
GateStatusWriterPolicy seam: write gate-run status (VCS identity + results). ran_at stays caller-supplied — the single non-deterministic input, kept out of the impl.
TerminalPolicyValidatorRuntime 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, diagram 17 nodes, 6 edges: vox-cli-contracts → vox-bounded-fs; vox-cli-contracts → vox-config; vox-cli-contracts → vox-jsonschema-util; vox-cli → vox-cli-contracts; vox-cli-ci → vox-cli-contracts; vox-cli-research → vox-cli-contractsvox-cli-contractsvox-bounded-fsvox-configvox-jsonschema-utilvox-clivox-cli-civox-cli-research
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
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
KindSymbolSignatureSourceDescription
structCheckManifestpub struct CheckManifestcrates/vox-cli-contracts/src/lib.rs#L24-L27Top-level structure of contracts/ci/check-targets.v1.yaml.
structCheckEntrypub struct CheckEntrycrates/vox-cli-contracts/src/lib.rs#L31-L43One quality-gate entry in the manifest.
traitCheckProviderpub trait CheckProvidercrates/vox-cli-contracts/src/lib.rs#L51-L53Audit seam: enumerate contracts/ci/check-targets.v1.yaml into policy entries. Replaces ci’s direct crate::commands::audit::CheckManifest deserialization.
traitGateStatusWriterpub trait GateStatusWritercrates/vox-cli-contracts/src/lib.rs#L57-L68Policy seam: write gate-run status (VCS identity + results). ran_at stays caller-supplied — the single non-deterministic input, kept out of the impl.
traitTerminalPolicyValidatorpub trait TerminalPolicyValidatorcrates/vox-cli-contracts/src/lib.rs#L72-L76Runtime 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.
fnscientia_ledger_contract::validate_finding_candidate_filepub fn validate_finding_candidate_file(repo_root: &Path, json_path: &Path) -> Result<()>crates/vox-cli-contracts/src/scientia_ledger_contract.rs#L59-L66Validate a finding-candidate JSON file against finding-candidate.v1.schema.json.
fnscientia_ledger_contract::validate_novelty_bundle_filepub fn validate_novelty_bundle_file(repo_root: &Path, json_path: &Path) -> Result<()>crates/vox-cli-contracts/src/scientia_ledger_contract.rs#L69-L76Validate a novelty-evidence-bundle JSON file against novelty-evidence-bundle.v1.schema.json.
fnscientia_ledger_contract::example_finding_candidate_pathpub fn example_finding_candidate_path(repo_root: &Path) -> PathBufcrates/vox-cli-contracts/src/scientia_ledger_contract.rs#L79-L81Default example paths (repo-relative) exercised by vox ci scientia-novelty-ledger-contracts.
fnscientia_ledger_contract::example_novelty_bundle_pathpub fn example_novelty_bundle_path(repo_root: &Path) -> PathBufcrates/vox-cli-contracts/src/scientia_ledger_contract.rs#L83-L85—