vox-foundation API Reference (generated)
Crate: vox-foundation · Version: 0.6.0 · Target: Library (lib.rs)
Utility umbrella: primitives (ids/backoff/agentos-mutation), protocol (daemon wire types), and tracing-init (tracing_subscriber presets). Consolidates vox-primitives, vox-protocol, and vox-tracing-init.
Crate Overview
Section titled “Crate Overview”Utility umbrella crate that consolidates small, low-dependency helpers shared across the Vox workspace.
Modules
Section titled “Modules”- [
primitives] — cheap trace ids, exponential backoff, AgentOS mutation kinds (wasvox-primitives) - [
protocol] — orchestrator daemon wire-protocol pure-data types (wasvox-protocol) - [
tracing] —tracing_subscriberbootstrap presets for CLIs and daemons (wasvox-tracing-init)
Migration
Section titled “Migration”Old crates are removed from the workspace; replace dependency entries:
| Old dep | New dep in Cargo.toml |
|---|---|
vox-primitives | vox-foundation |
vox-protocol | vox-foundation |
vox-tracing-init | vox-foundation |
Use paths are unchanged — e.g. vox_foundation::primitives::backoff::expo_backoff.
Features
Section titled “Features”| Feature | Default / Enables |
|---|---|
default | — |
otel | dep:opentelemetry, dep:opentelemetry-otlp, dep:opentelemetry_sdk, dep:tracing-opentelemetry |
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
primitives | — |
protocol | — |
tracing | — |
Dependency Topology
Section titled “Dependency Topology”Diagram source
graph { direction: right node vox_foundation: "vox-foundation" node vox_actor_runtime: "vox-actor-runtime" vox_actor_runtime -> vox_foundation node vox_cli: "vox-cli" vox_cli -> vox_foundation node vox_cli_core: "vox-cli-core" vox_cli_core -> vox_foundation node vox_cli_research: "vox-cli-research" vox_cli_research -> vox_foundation node vox_compiler: "vox-compiler" vox_compiler -> vox_foundation node vox_gui: "vox-gui" vox_gui -> vox_foundation node vox_lsp: "vox-lsp" vox_lsp -> vox_foundation node vox_ml_cli: "vox-ml-cli" vox_ml_cli -> vox_foundation node vox_orchestrator: "vox-orchestrator" vox_orchestrator -> vox_foundation node vox_orchestrator_d: "vox-orchestrator-d" vox_orchestrator_d -> vox_foundation node vox_orchestrator_mcp: "vox-orchestrator-mcp" vox_orchestrator_mcp -> vox_foundation node vox_plugin_populi_mesh: "vox-plugin-populi-mesh" vox_plugin_populi_mesh -> vox_foundation}Reverse Dependents (Used By)
Section titled “Reverse Dependents (Used By)”| Consumer Crate | Role |
|---|---|
vox-actor-runtime | Direct workspace dependent |
vox-cli | Direct workspace dependent |
vox-cli-core | Direct workspace dependent |
vox-cli-research | Direct workspace dependent |
vox-compiler | Direct workspace dependent |
vox-gui | Direct workspace dependent |
vox-lsp | Direct workspace dependent |
vox-ml-cli | Direct workspace dependent |
vox-orchestrator | Direct workspace dependent |
vox-orchestrator-d | Direct workspace dependent |
vox-orchestrator-mcp | Direct workspace dependent |
vox-plugin-populi-mesh | Direct workspace dependent |
vox-populi | Direct workspace dependent |
vox-publisher | Direct workspace dependent |
vox-python-bridge | Direct workspace dependent |
Deep Public Symbols (Source-Anchored)
Section titled “Deep Public Symbols (Source-Anchored)”| Kind | Symbol | Signature | Source | Description |
|---|---|---|---|---|
struct | protocol::DispatchRequest | pub struct DispatchRequest | crates/vox-foundation/src/protocol.rs#L192-L216 | Outgoing request from thin clients to Dei-style JSON-line daemons. |
struct | protocol::DispatchResponse | pub struct DispatchResponse | crates/vox-foundation/src/protocol.rs#L220-L223 | Incoming response envelope from Dei-style JSON-line daemons. |
enum | protocol::DispatchPayload | pub enum DispatchPayload | crates/vox-foundation/src/protocol.rs#L249-L287 | Payload variants for streaming and final Dei responses. |
fn | tracing::try_init_cli_default_info_fallback | pub fn try_init_cli_default_info_fallback() | crates/vox-foundation/src/tracing.rs#L21-L28 | CLI preset: honor RUST_LOG when valid; otherwise default filter info. Writes to stderr — vox’s stdout is reserved for command output (including the machine-parseable --json envelopes emitted by vox build/check/test), so a stray tracing::info!/warn! anywhere in the dependency graph must never land on stdout and break that contract. |
fn | tracing::try_init_from_default_env | pub fn try_init_from_default_env() | crates/vox-foundation/src/tracing.rs#L31-L36 | Daemon/service preset: [EnvFilter::from_default_env] (unset ⇒ subscriber default levels). |
fn | tracing::try_init_from_default_env_stderr | pub fn try_init_from_default_env_stderr() | crates/vox-foundation/src/tracing.rs#L39-L45 | Like [try_init_from_default_env] but writes logs to stderr (LSP and tools that reserve stdout). |
fn | tracing::init_otel_layer | pub fn init_otel_layer() -> Option< | crates/vox-foundation/src/tracing.rs#L52 | Optional OpenTelemetry OTLP layer for subscribers when the otel feature is enabled. Reads OTEL_EXPORTER_OTLP_ENDPOINT (and standard OTEL env vars honored by the OTLP exporter). Returns None when the endpoint is unset so callers can keep fmt-only init. |