Skip to content

vox-build-meta API Reference (generated)

Crate: vox-build-meta · Version: 0.6.0 · Target: Library (lib.rs)

Build-time helper that emits VOX_BUILD_NUMBER and VOX_GIT_HASH. Add to [build-dependencies] and call vox_build_meta::emit() from build.rs.

Build-time metadata injection — call [emit] from any build.rs.

Emits two cargo:rustc-env lines that downstream crates can consume with env!():

  • VOX_BUILD_NUMBER — git commit count on HEAD, auto-increments on every merge.
  • VOX_GIT_HASH — short SHA for diagnostics; never used in version comparison.

The full display string produced by binaries is:

{CARGO_PKG_VERSION}+build.{VOX_BUILD_NUMBER} ({VOX_GIT_HASH})

This crate has no runtime dependencies — it must only be used as a [build-dependencies] entry.

FunctionDescription
emitEmit version metadata cargo:rustc-env vars from a build script. Call this once from build.rs. Each binary’s build script may add its own cargo:rerun-if-changed lines after this call.
Dependency Topology, diagram 13 nodes, 2 edges: vox-cli → vox-build-meta; vox-gui → vox-build-metavox-build-metavox-clivox-gui
Diagram source
graph {
direction: right
node vox_build_meta: "vox-build-meta"
node vox_cli: "vox-cli"
vox_cli -> vox_build_meta
node vox_gui: "vox-gui"
vox_gui -> vox_build_meta
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-guiDirect workspace dependent
KindSymbolSignatureSourceDescription
fnemitpub fn emit()crates/vox-build-meta/src/lib.rs#L23-L33Emit version metadata cargo:rustc-env vars from a build script. Call this once from build.rs. Each binary’s build script may add its own cargo:rerun-if-changed lines after this call.