Skip to content

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.

Utility umbrella crate that consolidates small, low-dependency helpers shared across the Vox workspace.

  • [primitives] — cheap trace ids, exponential backoff, AgentOS mutation kinds (was vox-primitives)
  • [protocol] — orchestrator daemon wire-protocol pure-data types (was vox-protocol)
  • [tracing] — tracing_subscriber bootstrap presets for CLIs and daemons (was vox-tracing-init)

Old crates are removed from the workspace; replace dependency entries:

Old depNew dep in Cargo.toml
vox-primitivesvox-foundation
vox-protocolvox-foundation
vox-tracing-initvox-foundation

Use paths are unchanged — e.g. vox_foundation::primitives::backoff::expo_backoff.

FeatureDefault / Enables
default—
oteldep:opentelemetry, dep:opentelemetry-otlp, dep:opentelemetry_sdk, dep:tracing-opentelemetry
ModuleDescription
primitives—
protocol—
tracing—
Dependency Topology, diagram 113 nodes, 12 edges: vox-actor-runtime → vox-foundation; vox-cli → vox-foundation; vox-cli-core → vox-foundation; vox-cli-research → vox-foundation; vox-compiler → vox-foundation; vox-gui → vox-foundation; vox-lsp → vox-foundation; vox-ml-cli → vox-foundation; vox-orchestrator → vox-foundation; vox-…vox-foundationvox-actor-runtimevox-clivox-cli-corevox-cli-researchvox-compilervox-guivox-lspvox-ml-clivox-orchestratorvox-orchestrator-dvox-orchestrator-mcpvox-plugin-populi-mesh
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
}
Consumer CrateRole
vox-actor-runtimeDirect workspace dependent
vox-cliDirect workspace dependent
vox-cli-coreDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-compilerDirect workspace dependent
vox-guiDirect workspace dependent
vox-lspDirect workspace dependent
vox-ml-cliDirect workspace dependent
vox-orchestratorDirect workspace dependent
vox-orchestrator-dDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-plugin-populi-meshDirect workspace dependent
vox-populiDirect workspace dependent
vox-publisherDirect workspace dependent
vox-python-bridgeDirect workspace dependent
KindSymbolSignatureSourceDescription
structprotocol::DispatchRequestpub struct DispatchRequestcrates/vox-foundation/src/protocol.rs#L192-L216Outgoing request from thin clients to Dei-style JSON-line daemons.
structprotocol::DispatchResponsepub struct DispatchResponsecrates/vox-foundation/src/protocol.rs#L220-L223Incoming response envelope from Dei-style JSON-line daemons.
enumprotocol::DispatchPayloadpub enum DispatchPayloadcrates/vox-foundation/src/protocol.rs#L249-L287Payload variants for streaming and final Dei responses.
fntracing::try_init_cli_default_info_fallbackpub fn try_init_cli_default_info_fallback()crates/vox-foundation/src/tracing.rs#L21-L28CLI 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.
fntracing::try_init_from_default_envpub fn try_init_from_default_env()crates/vox-foundation/src/tracing.rs#L31-L36Daemon/service preset: [EnvFilter::from_default_env] (unset ⇒ subscriber default levels).
fntracing::try_init_from_default_env_stderrpub fn try_init_from_default_env_stderr()crates/vox-foundation/src/tracing.rs#L39-L45Like [try_init_from_default_env] but writes logs to stderr (LSP and tools that reserve stdout).
fntracing::init_otel_layerpub fn init_otel_layer() -> Option<crates/vox-foundation/src/tracing.rs#L52Optional 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.