Skip to content

vox-orchestrator-types API Reference (generated)

Crate: vox-orchestrator-types · Version: 0.6.0 · Target: Library (lib.rs)

Pure-data L0 leaf for vox-orchestrator: agent/task IDs, file affinity, switch actions, provider catalogs.

Pure-types L0 leaf for vox-orchestrator: agent/task IDs, file affinity, switch actions, provider catalogs.

No async runtime, no DB. Consumers wanting just the wire/data shape depend here instead of pulling in the full orchestrator.

ModuleDescription
agent_types—
clutch—
merge_outcome—
pricing—
routing_values—
socrates_policy—
task_priority—
trust—
vcs_capability—
StructDescription
HuggingFaceDedicatedEndpointPinned Inference Endpoint (dedicated deployment) with an explicit OpenAI-compatible chat URL.
HuggingFaceRouterEndpointResolved router endpoint for chat; bearer token is optional for some public models but usually required.
EnumDescription
ChatRouteBackendNormalized HTTP/backend lane for chat route telemetry.
ChatProviderRouteKindResolved high-level route before HTTP client configuration.
FunctionDescription
route_backend_for_chat_route—
backend_telemetry_labels—
Dependency Topology, diagram 19 nodes, 8 edges: vox-actor-runtime → vox-orchestrator-types; vox-db → vox-orchestrator-types; vox-orchestrator → vox-orchestrator-types; vox-orchestrator-mcp → vox-orchestrator-types; vox-orchestrator-models → vox-orchestrator-types; vox-orchestrator-queue → vox-orchestrator-types; vox-orchestrato…vox-orchestrator-typesvox-actor-runtimevox-dbvox-orchestratorvox-orchestrator-mcpvox-orchestrator-modelsvox-orchestrator-queuevox-orchestrator-test-helpersvox-research-shim
Diagram source
graph {
direction: right
node vox_orchestrator_types: "vox-orchestrator-types"
node vox_actor_runtime: "vox-actor-runtime"
vox_actor_runtime -> vox_orchestrator_types
node vox_db: "vox-db"
vox_db -> vox_orchestrator_types
node vox_orchestrator: "vox-orchestrator"
vox_orchestrator -> vox_orchestrator_types
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_orchestrator_types
node vox_orchestrator_models: "vox-orchestrator-models"
vox_orchestrator_models -> vox_orchestrator_types
node vox_orchestrator_queue: "vox-orchestrator-queue"
vox_orchestrator_queue -> vox_orchestrator_types
node vox_orchestrator_test_helpers: "vox-orchestrator-test-helpers"
vox_orchestrator_test_helpers -> vox_orchestrator_types
node vox_research_shim: "vox-research-shim"
vox_research_shim -> vox_orchestrator_types
}
Consumer CrateRole
vox-actor-runtimeDirect workspace dependent
vox-dbDirect workspace dependent
vox-orchestratorDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-orchestrator-modelsDirect workspace dependent
vox-orchestrator-queueDirect workspace dependent
vox-orchestrator-test-helpersDirect workspace dependent
vox-research-shimDirect workspace dependent
KindSymbolSignatureSourceDescription
structHuggingFaceDedicatedEndpointpub struct HuggingFaceDedicatedEndpointcrates/vox-orchestrator-types/src/lib.rs#L38-L42Pinned Inference Endpoint (dedicated deployment) with an explicit OpenAI-compatible chat URL.
structHuggingFaceRouterEndpointpub struct HuggingFaceRouterEndpointcrates/vox-orchestrator-types/src/lib.rs#L46-L50Resolved router endpoint for chat; bearer token is optional for some public models but usually required.
enumChatRouteBackendpub enum ChatRouteBackendcrates/vox-orchestrator-types/src/lib.rs#L55-L67Normalized HTTP/backend lane for chat route telemetry.
enumChatProviderRouteKindpub enum ChatProviderRouteKindcrates/vox-orchestrator-types/src/lib.rs#L72-L89Resolved high-level route before HTTP client configuration.
fnroute_backend_for_chat_routepub fn route_backend_for_chat_route(route: &ChatProviderRouteKind) -> ChatRouteBackendcrates/vox-orchestrator-types/src/lib.rs#L92-L110—
fnbackend_telemetry_labelspub fn backend_telemetry_labels(backend: ChatRouteBackend) -> (&'static str, &'static str)crates/vox-orchestrator-types/src/lib.rs#L113-L122—
enumclutch::QualityLevelpub enum QualityLevelcrates/vox-orchestrator-types/src/clutch.rs#L6-L11—
fnclutch::to_cost_preferencepub fn to_cost_preference(self) -> CostPreferencecrates/vox-orchestrator-types/src/clutch.rs#L20-L25Map quality level to a cost preference for model selection. Free-by-default policy: Flash and Balanced both resolve to Economy so that the two most common quality tiers prefer free/cheap models. Only Premium opts in to Performance (paid-model-preferred) routing.
enumclutch::BudgetAggressivenesspub enum BudgetAggressivenesscrates/vox-orchestrator-types/src/clutch.rs#L30-L34Budget-gate aggressiveness selected by the clutch.
fnclutch::thresholdspub fn thresholds(self) -> (f64, f64)crates/vox-orchestrator-types/src/clutch.rs#L39-L45(downgrade_fraction, halt_fraction) for the orchestrator budget gate.
structclutch::ResolvedClutchpub struct ResolvedClutchcrates/vox-orchestrator-types/src/clutch.rs#L50-L58Resolved control knobs for one clutch detent. Pure data — no I/O.
enumclutch::ClutchProfilepub enum ClutchProfilecrates/vox-orchestrator-types/src/clutch.rs#L63-L69User-facing “how much gas” control. Single SSOT for the four detents.
fnclutch::from_labelpub fn from_label(label: &str) -> Option<Self>crates/vox-orchestrator-types/src/clutch.rs#L76-L84Parse a GUI-supplied label into a profile. Case-insensitive; matches lib/driveConsole.ts ClutchId exactly (free|efficiency|balanced|genius). Unknown labels return None.
fnclutch::resolvepub fn resolve(self) -> ResolvedClutchcrates/vox-orchestrator-types/src/clutch.rs#L87-L126—
structmerge_outcome::DaemonIdpub struct DaemonId(pub [u8; 16])crates/vox-orchestrator-types/src/merge_outcome.rs#L17Opaque 16-byte daemon node identity (UUIDv4 bytes in network order). Defined here so MergeOutcome can reference it without pulling in the full orchestrator-queue crate.
enummerge_outcome::MergeOutcomepub enum MergeOutcomecrates/vox-orchestrator-types/src/merge_outcome.rs#L22-L42Three-tier conflict-funnel outcome for branch-merge and lock operations.
fnmerge_outcome::is_mergedpub fn is_merged(&self) -> boolcrates/vox-orchestrator-types/src/merge_outcome.rs#L46-L48Returns true if the merge completed without any conflict.
fnmerge_outcome::is_lock_waitpub fn is_lock_wait(&self) -> boolcrates/vox-orchestrator-types/src/merge_outcome.rs#L51-L53Returns true if the caller should retry after a lease expires.
fnmerge_outcome::lock_wait_lease_mspub fn lock_wait_lease_ms(&self) -> Option<u64>crates/vox-orchestrator-types/src/merge_outcome.rs#L56-L62Returns the suggested retry delay when LockWait, otherwise None.
enumpricing::PricingSourcepub enum PricingSourcecrates/vox-orchestrator-types/src/pricing.rs#L8-L26Records which data source last set the pricing fields on a ModelSpec. Priority (highest → lowest): Telemetry > LiteLLM > OpenRouter | AnthropicDirect > UserConfig > Bootstrap.
enumrouting_values::CostPreferencepub enum CostPreferencecrates/vox-orchestrator-types/src/routing_values.rs#L9-L15Preference for balancing model quality vs operational cost. Default is Economy — free-by-default product directive. Callers that genuinely need the best model available should pass Performance explicitly.
enumrouting_values::RoutingProfilepub enum RoutingProfilecrates/vox-orchestrator-types/src/routing_values.rs#L21-L31Cost/tier-oriented routing profile. [Default] is Free — the free-by-default product directive.
fnrouting_values::as_strpub fn as_str(self) -> &'static strcrates/vox-orchestrator-types/src/routing_values.rs#L36-L43Canonical string key for telemetry / persistence.
fnrouting_values::is_free_onlypub fn is_free_only(self) -> boolcrates/vox-orchestrator-types/src/routing_values.rs#L49-L51True when this profile should restrict selection to free-tier models (no paid fallback). Mixed prefers free but permits a paid fallback, so it is not free-only.
fnrouting_values::prefers_freepub fn prefers_free(self) -> boolcrates/vox-orchestrator-types/src/routing_values.rs#L55-L57True when this profile prefers free models but allows a paid fallback.
fnrouting_values::is_local_onlypub fn is_local_only(self) -> boolcrates/vox-orchestrator-types/src/routing_values.rs#L61-L63True when this profile restricts selection to local providers.
enumtask_priority::TaskPrioritypub enum TaskPrioritycrates/vox-orchestrator-types/src/task_priority.rs#L6-L13Priority level for a task. Higher priority tasks are dequeued first.
fntask_priority::from_u8pub fn from_u8(v: u8) -> Selfcrates/vox-orchestrator-types/src/task_priority.rs#L21-L27Map a wire u8 (e.g. the priority field of a HopperSync op) to a TaskPriority. Matches the enum’s repr (0/1/2); any out-of-range value falls back to Normal rather than failing — replication should degrade gracefully, not drop an admission.
enumtrust::ContextTrustTierpub enum ContextTrustTiercrates/vox-orchestrator-types/src/trust.rs#L33-L38Trust tier used by context conflict and injection policy. Declaration order is ascending trust, so Ord/min pick the least trusted.
fntrust::as_db_strpub fn as_db_str(self) -> &'static strcrates/vox-orchestrator-types/src/trust.rs#L42-L49The stored wire string (matches the serde form).
fntrust::from_db_strpub fn from_db_str(s: &str) -> Selfcrates/vox-orchestrator-types/src/trust.rs#L52-L59Exact, case-sensitive parse; anything unrecognised is Untrusted.
enumtrust::FindingTierpub enum FindingTiercrates/vox-orchestrator-types/src/trust.rs#L65-L68Tiers a finding may carry. A finding can never be Trusted or SystemVerified.
fntrust::as_db_strpub fn as_db_str(self) -> &'static strcrates/vox-orchestrator-types/src/trust.rs#L71-L73—
fntrust::tier_for_curatedpub fn tier_for_curated(has_mechanical_evidence: bool) -> ContextTrustTiercrates/vox-orchestrator-types/src/trust.rs#L86-L92Tier for curated content: SystemVerified with mechanical evidence, else Trusted.
fntrust::tier_for_knowledge_node_typepub fn tier_for_knowledge_node_type(node_type: Option<&str>) -> ContextTrustTiercrates/vox-orchestrator-types/src/trust.rs#L104-L109Tier for a knowledge-graph node type. Allowlist of two Advisory types; every other or missing type is Untrusted (D-06 taint rule). fact and concept are Advisory only for non-agent writers (D-07 narrows D-06): agent writers use [AGENT_FACT_NODE_TYPE] / [AGENT_CONCEPT_NODE_TYPE].
structvcs_capability::WorkspaceIdpub struct WorkspaceId(pub u64)crates/vox-orchestrator-types/src/vcs_capability.rs#L22—
structvcs_capability::BranchNamepub struct BranchName(String)crates/vox-orchestrator-types/src/vcs_capability.rs#L31—
fnvcs_capability::parsepub fn parse(s: &str) -> Result<Self, BranchNameError>crates/vox-orchestrator-types/src/vcs_capability.rs#L45-L62Reject empty, whitespace, and any name containing characters git refuses. Matches the subset of git check-ref-format --branch we care about for agent-generated names: ASCII, no spaces, no .., :, ?, *, [, \, ^, ~, no leading / or -, length 1..=255. Known gaps (not currently rejected — caller may still see a git error downstream): leading ., trailing ., .lock suffix, trailing /, consecutive //. These are unlikely from agent-style names like agent/<slug> and are deliberately not enforced in Phase 1 to keep the validator small. Tighten if a real callsite trips on them.
fnvcs_capability::as_strpub fn as_str(&self) -> &strcrates/vox-orchestrator-types/src/vcs_capability.rs#L64-L66—
enumvcs_capability::BranchNameErrorpub enum BranchNameErrorcrates/vox-orchestrator-types/src/vcs_capability.rs#L70-L79—
structvcs_capability::RemoteIdpub struct RemoteId(pub u32)crates/vox-orchestrator-types/src/vcs_capability.rs#L82—
structvcs_capability::WorkingTreeWritepub struct WorkingTreeWritecrates/vox-orchestrator-types/src/vcs_capability.rs#L87-L90Capability: holder may stage and commit hunks against branch of workspace. Constructed only via vox-orchestrator-cap-mint::mint_working_tree_write.
fnvcs_capability::workspacepub fn workspace(&self) -> WorkspaceIdcrates/vox-orchestrator-types/src/vcs_capability.rs#L101-L103—
fnvcs_capability::branchpub fn branch(&self) -> &BranchNamecrates/vox-orchestrator-types/src/vcs_capability.rs#L104-L106—
structvcs_capability::BranchCreatepub struct BranchCreatecrates/vox-orchestrator-types/src/vcs_capability.rs#L111-L114Capability: holder may create a new branch in workspace rooted at parent.