Skip to content

vox-plugin-types API Reference (generated)

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

Pure-types surface for the vox plugin system: manifests, skill types, state-backend trait. No abi_stable, no async runtime.

Pure-types surface for the vox plugin system.

Designed to be a leaf dep: no async runtime, no DB client, no abi_stable. Crates that need only the manifest/skill/state-backend shapes can depend here without pulling in vox-plugin-api’s full ABI machinery or vox-db.

Re-exported by vox-plugin-api (manifest types) and vox-plugin-host (skill manifest + state-backend trait) for backwards compatibility.

ModuleDescription
plugin_manifest—
skill_identity—
skill_manifest—
state_backend—
target—
Dependency Topology, diagram 110 nodes, 9 edges: vox-cli → vox-plugin-types; vox-cli-ci → vox-plugin-types; vox-cli-research → vox-plugin-types; vox-db → vox-plugin-types; vox-orchestrator-mcp → vox-plugin-types; vox-plugin-api → vox-plugin-types; vox-plugin-host → vox-plugin-types; vox-plugin-test-harness → vox-plugin-types; v…vox-plugin-typesvox-clivox-cli-civox-cli-researchvox-dbvox-orchestrator-mcpvox-plugin-apivox-plugin-hostvox-plugin-test-harnessvox-skill-discovery
Diagram source
graph {
direction: right
node vox_plugin_types: "vox-plugin-types"
node vox_cli: "vox-cli"
vox_cli -> vox_plugin_types
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_plugin_types
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_plugin_types
node vox_db: "vox-db"
vox_db -> vox_plugin_types
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_plugin_types
node vox_plugin_api: "vox-plugin-api"
vox_plugin_api -> vox_plugin_types
node vox_plugin_host: "vox-plugin-host"
vox_plugin_host -> vox_plugin_types
node vox_plugin_test_harness: "vox-plugin-test-harness"
vox_plugin_test_harness -> vox_plugin_types
node vox_skill_discovery: "vox-skill-discovery"
vox_skill_discovery -> vox_plugin_types
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-dbDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-plugin-apiDirect workspace dependent
vox-plugin-hostDirect workspace dependent
vox-plugin-test-harnessDirect workspace dependent
vox-skill-discoveryDirect workspace dependent
KindSymbolSignatureSourceDescription
structplugin_manifest::PluginManifestpub struct PluginManifestcrates/vox-plugin-types/src/plugin_manifest.rs#L9-L11—
structplugin_manifest::PluginHeaderpub struct PluginHeadercrates/vox-plugin-types/src/plugin_manifest.rs#L15-L43—
enumplugin_manifest::PluginStatuspub enum PluginStatuscrates/vox-plugin-types/src/plugin_manifest.rs#L48-L53Lifecycle stage of a plugin.
structplugin_manifest::HostRequirementpub struct HostRequirementcrates/vox-plugin-types/src/plugin_manifest.rs#L57-L59—
enumplugin_manifest::PluginPayloadpub enum PluginPayloadcrates/vox-plugin-types/src/plugin_manifest.rs#L63-L67—
structplugin_manifest::CodePayloadpub struct CodePayloadcrates/vox-plugin-types/src/plugin_manifest.rs#L71-L88—
structplugin_manifest::PayloadProvidespub struct PayloadProvidescrates/vox-plugin-types/src/plugin_manifest.rs#L92-L95—
structplugin_manifest::PayloadRequirespub struct PayloadRequirescrates/vox-plugin-types/src/plugin_manifest.rs#L99-L106—
structplugin_manifest::NativeLibpub struct NativeLibcrates/vox-plugin-types/src/plugin_manifest.rs#L110-L114—
structplugin_manifest::SkillPayloadpub struct SkillPayloadcrates/vox-plugin-types/src/plugin_manifest.rs#L118-L123—
structplugin_manifest::SkillToolspub struct SkillToolscrates/vox-plugin-types/src/plugin_manifest.rs#L127-L130—
structplugin_manifest::CompositePayloadpub struct CompositePayloadcrates/vox-plugin-types/src/plugin_manifest.rs#L134-L137—
enumskill_identity::SkillNamespacepub enum SkillNamespacecrates/vox-plugin-types/src/skill_identity.rs#L52-L66The namespace half of a [SkillIdentity].
fnskill_identity::is_externalpub fn is_external(&self) -> boolcrates/vox-plugin-types/src/skill_identity.rs#L81-L83True for anything that isn’t [SkillNamespace::Local] — the distinction the stricter externally-sourced install gate (Task 3.4 design point 3) keys off of.
structskill_identity::SkillIdentitypub struct SkillIdentitycrates/vox-plugin-types/src/skill_identity.rs#L88-L91A parsed, validated skill identity: <namespace>/<name>.
enumskill_identity::SkillIdentityErrorpub enum SkillIdentityErrorcrates/vox-plugin-types/src/skill_identity.rs#L95-L106Error returned by [SkillIdentity::parse].
fnskill_identity::parsepub fn parse(id: &str) -> Result<Self, SkillIdentityError>crates/vox-plugin-types/src/skill_identity.rs#L120-L149Parse id (e.g. a [crate::skill_manifest::SkillManifest::id]) into a validated namespace + name pair. Backward compatibility: ids predating this scheme (e.g. "vox.compiler", "vox.docs" — bundled first-party skills with no / at all) are treated as implicitly [SkillNamespace::Local] with the whole id as the name, un-validated against the character set below. Only ids that opt into the explicit <namespace>/<name> form are format-checked. This lets existing bundled skill manifests keep their ids as-is while new/external skills are required to namespace themselves.
fnskill_identity::is_externalpub fn is_external(&self) -> boolcrates/vox-plugin-types/src/skill_identity.rs#L153-L155True when this identity requires the stricter externally-sourced install gate (namespace present + minimum reliability signal).
structskill_manifest::SkillManifestpub struct SkillManifestcrates/vox-plugin-types/src/skill_manifest.rs#L15-L48A complete skill manifest (equivalent to OpenClaw’s skill.json / SKILL.md frontmatter). Implements Default so construction sites that only need the core five fields (id, name, version, description, tools) can use ..Default::default() for the rest. This is the canonical, unified type used everywhere in the plugin stack.
fnskill_manifest::newpub fn new(crates/vox-plugin-types/src/skill_manifest.rs#L51—
enumskill_manifest::SkillCategorypub enum SkillCategorycrates/vox-plugin-types/src/skill_manifest.rs#L80-L97Skill category for marketplace browsing and filtering.
enumskill_manifest::SkillPermissionpub enum SkillPermissioncrates/vox-plugin-types/src/skill_manifest.rs#L111-L126Permissions a skill may require at install time.
structstate_backend::PluginStateSkillEntrypub struct PluginStateSkillEntrycrates/vox-plugin-types/src/state_backend.rs#L13-L18One row from the underlying skill-manifest store, returned by [PluginStateBackend::list_skill_manifests].
structstate_backend::PluginStateErrorpub struct PluginStateError(pub String)crates/vox-plugin-types/src/state_backend.rs#L24Errors a state backend may return. Backends stringify their internal errors so the host doesn’t depend on backend-specific error types.
fnstate_backend::newpub fn new(msg: impl Into<String>) -> Selfcrates/vox-plugin-types/src/state_backend.rs#L27-L29—
traitstate_backend::PluginStateBackendpub trait PluginStateBackend: Send + Synccrates/vox-plugin-types/src/state_backend.rs#L35-L70Trait the plugin host uses for persistent skill state. Implemented by vox-db (concrete) and any test/in-memory double.
fntarget::current_target_triplepub fn current_target_triple() -> Option<&'static str>crates/vox-plugin-types/src/target.rs#L19-L35The platform key for the crate currently being compiled, or None on a platform Vox plugins don’t target. The returned value (when Some) is always in [PLUGIN_TARGET_TRIPLES].
fntarget::plugin_artifact_filenamepub fn plugin_artifact_filename(crate_name: &str, triple: &str) -> Option<String>crates/vox-plugin-types/src/target.rs#L44-L56The cdylib filename a plugin crate produces for triple. Rule: a crate-type = ["cdylib"] lib named vox-plugin-foo builds vox_plugin_foo.dll (Windows), libvox_plugin_foo.so (Linux), or libvox_plugin_foo.dylib (macOS). crate_name is the crate directory / package name (e.g. "vox-plugin-nvml-probe"); hyphens become underscores. Returns None for a triple outside [PLUGIN_TARGET_TRIPLES].