Skip to content

vox-package-types API Reference (generated)

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

Pure-data L1 leaf for vox-package: Vox.toml manifest types, vox.lock types, package_kind enum, resolver request/response types.

Pure-data L1 leaf for vox-package: Vox.toml manifest types, vox.lock types, package_kind enum, resolver request/response types. No async, no DB, no compiler dependency.

ModuleDescription
deploy_coolify[deploy.coolify] manifest shapes (serde-only).
lockfilevox.lock lockfile format.
manifestVox.toml manifest parsing and serialization.
package_kindEnumerates artifact kinds that VoxPM can manage as packages.
resolverSemantic versions and dependency resolution helpers.
Dependency Topology, diagram 14 nodes, 3 edges: vox-gui → vox-package-types; vox-package → vox-package-types; vox-project-scaffold → vox-package-typesvox-package-typesvox-guivox-packagevox-project-scaffold
Diagram source
graph {
direction: right
node vox_package_types: "vox-package-types"
node vox_gui: "vox-gui"
vox_gui -> vox_package_types
node vox_package: "vox-package"
vox_package -> vox_package_types
node vox_project_scaffold: "vox-project-scaffold"
vox_project_scaffold -> vox_package_types
}
Consumer CrateRole
vox-guiDirect workspace dependent
vox-packageDirect workspace dependent
vox-project-scaffoldDirect workspace dependent
KindSymbolSignatureSourceDescription
enumdeploy_coolify::CoolifyEnvReconciliationModepub enum CoolifyEnvReconciliationModecrates/vox-package-types/src/deploy_coolify.rs#L11-L17How manifest env vars are applied relative to the remote Coolify app.
enumdeploy_coolify::CoolifyEnvVarSpecpub enum CoolifyEnvVarSpeccrates/vox-package-types/src/deploy_coolify.rs#L22-L27Either a literal string or a structured env entry (value vs value_env, flags, …).
structdeploy_coolify::CoolifyEnvVarDetailpub struct CoolifyEnvVarDetailcrates/vox-package-types/src/deploy_coolify.rs#L31-L43Structured Coolify env var definition under [deploy.coolify.env].
structdeploy_coolify::CoolifyDeployConfigpub struct CoolifyDeployConfigcrates/vox-package-types/src/deploy_coolify.rs#L51-L74Coolify application and sync settings ([deploy.coolify]).
structlockfile::Lockfilepub struct Lockfilecrates/vox-package-types/src/lockfile.rs#L12-L21Represents the vox.lock lockfile. Records exact resolved versions and content hashes for reproducible installs.
structlockfile::LockedPackagepub struct LockedPackagecrates/vox-package-types/src/lockfile.rs#L24-L33—
enumlockfile::PackageSourcepub enum PackageSourcecrates/vox-package-types/src/lockfile.rs#L37-L46—
fnlockfile::newpub fn new() -> Selfcrates/vox-package-types/src/lockfile.rs#L70-L76Create a new empty lockfile.
fnlockfile::set_python_uv_lock_hashpub fn set_python_uv_lock_hash(&mut self, hash: impl Into<String>)crates/vox-package-types/src/lockfile.rs#L79-L81Record the BLAKE3 hex digest of uv.lock.
fnlockfile::addpub fn add(crates/vox-package-types/src/lockfile.rs#L84Add or update a resolved package.
fnlockfile::is_lockedpub fn is_locked(&self, name: &str, version: &SemVer) -> boolcrates/vox-package-types/src/lockfile.rs#L106-L111Check if a package is locked at a specific version.
fnlockfile::get_locked_versionpub fn get_locked_version(&self, name: &str) -> Option<SemVer>crates/vox-package-types/src/lockfile.rs#L114-L118Get the locked version of a package.
fnlockfile::removepub fn remove(&mut self, name: &str) -> boolcrates/vox-package-types/src/lockfile.rs#L121-L123Remove a package from the lockfile.
fnlockfile::to_toml_stringpub fn to_toml_string(&self) -> Result<String, LockfileError>crates/vox-package-types/src/lockfile.rs#L126-L184Serialize to TOML string.
fnlockfile::loadpub fn load(path: &Path) -> Result<Self, LockfileError>crates/vox-package-types/src/lockfile.rs#L187-L190Load from a lockfile path.
fnlockfile::from_strpub fn from_str(content: &str) -> Result<Self, LockfileError>crates/vox-package-types/src/lockfile.rs#L193-L268Parse from a TOML string. For simplicity, uses serde_json round-trip.
fnlockfile::savepub fn save(&self, path: &Path) -> Result<(), LockfileError>crates/vox-package-types/src/lockfile.rs#L271-L274Save to a file path.
enumlockfile::LockfileErrorpub enum LockfileErrorcrates/vox-package-types/src/lockfile.rs#L278-L281—
structmanifest::VoxManifestpub struct VoxManifestcrates/vox-package-types/src/manifest.rs#L10-L39Represents the full Vox.toml manifest.
enummanifest::SchemaOwnerpub enum SchemaOwnercrates/vox-package-types/src/manifest.rs#L44-L51Who owns the app database schema ([db] schema_owner).
structmanifest::DbSectionpub struct DbSectioncrates/vox-package-types/src/manifest.rs#L55-L58[db] section of Vox.toml.
fnmanifest::from_manifest_strpub fn from_manifest_str(content: &str) -> Result<Self, ManifestError>crates/vox-package-types/src/manifest.rs#L63-L71Read only [db] from Vox.toml content (default when absent). Does not require [package], so callers that only need DB settings accept partial manifests.
structmanifest::PythonSectionpub struct PythonSectioncrates/vox-package-types/src/manifest.rs#L84-L95[python] section of Vox.toml.
fnmanifest::from_manifest_strpub fn from_manifest_str(content: &str) -> Result<Option<Self>, ManifestError>crates/vox-package-types/src/manifest.rs#L100-L108Read [python] from manifest text. Ok(None) when the section is absent. Does not require [package].
structmanifest::PackageSectionpub struct PackageSectioncrates/vox-package-types/src/manifest.rs#L112-L132—
structmanifest::BinSpecpub struct BinSpeccrates/vox-package-types/src/manifest.rs#L142-L147—
enummanifest::DependencySpecpub enum DependencySpeccrates/vox-package-types/src/manifest.rs#L152-L157A dependency specification — either a simple version string or a detailed table.
fnmanifest::version_reqpub fn version_req(&self) -> Option<&str>crates/vox-package-types/src/manifest.rs#L161-L166Get the version requirement string, if any.
fnmanifest::is_pathpub fn is_path(&self) -> boolcrates/vox-package-types/src/manifest.rs#L169-L171Check if this is a path dependency.
fnmanifest::pathpub fn path(&self) -> Option<&str>crates/vox-package-types/src/manifest.rs#L174-L179Get the local path if this is a path dependency.
fnmanifest::featurespub fn features(&self) -> &[String]crates/vox-package-types/src/manifest.rs#L182-L187Get requested features.
structmanifest::DetailedDependencypub struct DetailedDependencycrates/vox-package-types/src/manifest.rs#L191-L206—
structmanifest::WorkspaceSectionpub struct WorkspaceSectioncrates/vox-package-types/src/manifest.rs#L209-L212—
structmanifest::DeploySectionpub struct DeploySectioncrates/vox-package-types/src/manifest.rs#L240-L271Deployment configuration from [deploy] section in Vox.toml. Supports multiple deployment targets with per-target sub-sections: toml [deploy] target = "auto" # "container" | "bare-metal" | "compose" | "k8s" | "auto" runtime = "auto" # "docker" | "podman" | "auto" [deploy.container] image_name = "my-app" registry = "ghcr.io/user" [deploy.bare-metal] host = "prod.example.com" user = "deploy" service_name = "my-app" // vox-arch-check: allow abs-path deploy_dir = "/opt/my-app" [deploy.kubernetes] cluster = "prod" namespace = "default" replicas = 3
fnmanifest::effective_image_namepub fn effective_image_name(&self) -> Option<&str>crates/vox-package-types/src/manifest.rs#L276-L281Resolve the effective image name: prefers [deploy.container].image_name, falls back to the legacy flat image_name field.
fnmanifest::effective_registrypub fn effective_registry(&self) -> Option<&str>crates/vox-package-types/src/manifest.rs#L285-L290Resolve the effective registry: prefers [deploy.container].registry, falls back to the legacy flat registry field.
structmanifest::ContainerDeployConfigpub struct ContainerDeployConfigcrates/vox-package-types/src/manifest.rs#L295-L308OCI container-specific deploy configuration ([deploy.container]).
structmanifest::BareMetalDeployConfigpub struct BareMetalDeployConfigcrates/vox-package-types/src/manifest.rs#L312-L327Bare-metal (systemd) deploy configuration ([deploy.bare-metal]).
structmanifest::ComposeDeployConfigpub struct ComposeDeployConfigcrates/vox-package-types/src/manifest.rs#L331-L341Docker / Podman Compose deploy configuration ([deploy.compose]).
structmanifest::KubernetesDeployConfigpub struct KubernetesDeployConfigcrates/vox-package-types/src/manifest.rs#L345-L358Kubernetes deploy configuration ([deploy.kubernetes]).
structmanifest::FlyDeployConfigpub struct FlyDeployConfigcrates/vox-package-types/src/manifest.rs#L362-L372Fly.io deploy configuration ([deploy.fly]).
fnmanifest::from_strpub fn from_str(content: &str) -> Result<Self, ManifestError>crates/vox-package-types/src/manifest.rs#L376-L378Parse a Vox.toml from a string.
fnmanifest::loadpub fn load(path: &Path) -> Result<Self, ManifestError>crates/vox-package-types/src/manifest.rs#L381-L384Load a Vox.toml from a file path.
fnmanifest::discoverpub fn discover(start_dir: &Path) -> Result<(Self, std::path::PathBuf), ManifestError>crates/vox-package-types/src/manifest.rs#L387-L399Find and load Vox.toml by searching from the given directory upwards.
fnmanifest::to_toml_stringpub fn to_toml_string(&self) -> Result<String, ManifestError>crates/vox-package-types/src/manifest.rs#L402-L404Serialize back to TOML string.