Skip to content

vox-plugin-api API Reference (generated)

Crate: vox-plugin-api · Version: 0.6.0 · Target: Library (lib.rs)

Shared API surface for Vox plugins: ABI version, traits, manifest types, error types.

Shared API surface for Vox plugins. Both host and code-payload plugin crates depend on this crate.

See: docs/src/architecture/plugin-system-redesign-2026.md

DependencyKind
vox-plugin-typesNormal
ModuleDescription
abi—
errors—
extensions—
host—
manifest—
skill—
FunctionDescription
abi_compatibleTrue when a plugin advertising plugin_abi is loadable by this host — i.e. it falls in the supported [VOX_PLUGIN_ABI_MIN_SUPPORTED, VOX_PLUGIN_ABI_VERSION] range.
ConstantDescription
VOX_PLUGIN_ABI_VERSIONThe newest plugin ABI this host speaks. A plugin built against this exact version always loads. Bumped on any ABI change (additive or breaking).
VOX_PLUGIN_ABI_MIN_SUPPORTEDThe oldest plugin ABI this host still accepts. A plugin whose embedded ABI is within VOX_PLUGIN_ABI_MIN_SUPPORTED ..= VOX_PLUGIN_ABI_VERSION loads without a rebuild — so a Vox release that doesn’t touch the extension traits never forces every plugin to be recompiled. ## Bump policy - Additive ABI change (a new extension point, or a new optional trait method guarded by an extension *_REVISION bump): raise [VOX_PLUGIN_ABI_VERSION] only and leave this constant — old plugin binaries keep loading. - Breaking ABI change (a changed/removed trait-method signature or struct layout): raise both this constant and [VOX_PLUGIN_ABI_VERSION] — older plugins are then rejected at load with a clear message. Breaking bumps should be rare and batched.
Dependency Topology, diagram 114 nodes, 13 edges: vox-plugin-api → vox-plugin-types; vox-cli → vox-plugin-api; vox-cli-ci → vox-plugin-api; vox-cli-research → vox-plugin-api; vox-integration-tests → vox-plugin-api; vox-orchestrator-mcp → vox-plugin-api; vox-plugin-browser → vox-plugin-api; vox-plugin-host → vox-plugin-api; vox-…vox-plugin-apivox-plugin-typesvox-clivox-cli-civox-cli-researchvox-integration-testsvox-orchestrator-mcpvox-plugin-browservox-plugin-hostvox-plugin-mens-candle-cudavox-plugin-mens-candle-metalvox-plugin-nvml-probevox-plugin-populi-meshvox-plugin-publication
Diagram source
graph {
direction: right
node vox_plugin_api: "vox-plugin-api"
node vox_plugin_types: "vox-plugin-types"
vox_plugin_api -> vox_plugin_types
node vox_cli: "vox-cli"
vox_cli -> vox_plugin_api
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_plugin_api
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_plugin_api
node vox_integration_tests: "vox-integration-tests"
vox_integration_tests -> vox_plugin_api
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_plugin_api
node vox_plugin_browser: "vox-plugin-browser"
vox_plugin_browser -> vox_plugin_api
node vox_plugin_host: "vox-plugin-host"
vox_plugin_host -> vox_plugin_api
node vox_plugin_mens_candle_cuda: "vox-plugin-mens-candle-cuda"
vox_plugin_mens_candle_cuda -> vox_plugin_api
node vox_plugin_mens_candle_metal: "vox-plugin-mens-candle-metal"
vox_plugin_mens_candle_metal -> vox_plugin_api
node vox_plugin_nvml_probe: "vox-plugin-nvml-probe"
vox_plugin_nvml_probe -> vox_plugin_api
node vox_plugin_populi_mesh: "vox-plugin-populi-mesh"
vox_plugin_populi_mesh -> vox_plugin_api
node vox_plugin_publication: "vox-plugin-publication"
vox_plugin_publication -> vox_plugin_api
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-integration-testsDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-plugin-browserDirect workspace dependent
vox-plugin-hostDirect workspace dependent
vox-plugin-mens-candle-cudaDirect workspace dependent
vox-plugin-mens-candle-metalDirect workspace dependent
vox-plugin-nvml-probeDirect workspace dependent
vox-plugin-populi-meshDirect workspace dependent
vox-plugin-publicationDirect workspace dependent
vox-plugin-runtime-containerDirect workspace dependent
vox-plugin-runtime-wasmDirect workspace dependent
vox-plugin-sdkDirect workspace dependent
vox-plugin-speechDirect workspace dependent
vox-plugin-webhookDirect workspace dependent
KindSymbolSignatureSourceDescription
fnabi_compatiblepub fn abi_compatible(plugin_abi: u32) -> boolcrates/vox-plugin-api/src/lib.rs#L35-L37True when a plugin advertising plugin_abi is loadable by this host — i.e. it falls in the supported [VOX_PLUGIN_ABI_MIN_SUPPORTED, VOX_PLUGIN_ABI_VERSION] range.
structabi::VoxPluginRootpub struct VoxPluginRootcrates/vox-plugin-api/src/abi.rs#L32-L38—
traitabi::VoxPluginpub trait VoxPlugin: Send + Synccrates/vox-plugin-api/src/abi.rs#L48-L132—
typeabi::VoxPluginRefpub type VoxPluginRef = VoxPlugin_TO<'static, RBox<()>>crates/vox-plugin-api/src/abi.rs#L134—
enumerrors::LogLevelpub enum LogLevelcrates/vox-plugin-api/src/errors.rs#L7-L13—
enumhost::SabiLogLevelpub enum SabiLogLevelcrates/vox-plugin-api/src/host.rs#L9-L15—
traithost::VoxHostpub trait VoxHost: Send + Synccrates/vox-plugin-api/src/host.rs#L30-L34—
structskill::LoadedSkillpub struct LoadedSkillcrates/vox-plugin-api/src/skill.rs#L12-L18—