This module provides the op_build_mod!()
macro that will generate a
public module named build
that contains build-time metadata.
This module is meant to be used with oysterpack_built,
which extracts The build-time info during compilation.
The generated build
module will consist of:
Constant | Type | Description
-------- | ---- | -----------
BUILTTIMEUTC|&str|The built-time in RFC822, UTC
CFGENDIAN|&str|The endianness, given by cfg!(targetendian).
CFGENV|&str|The toolchain-environment, given by cfg!(targetenv).
CFGFAMILY|&str|The OS-family, given by cfg!(targetfamily).
CFGOS|&str|The operating system, given by cfg!(targetos).
CFGPOINTERWIDTH|u8|The pointer width, given by cfg!(targetpointerwidth).
CFGTARGETARCH|&str|The target architecture, given by cfg!(targetarch).
CIPLATFORM|Option<&str>|The Continuous Integration platform detected during compilation.
DEBUG|bool|Value of DEBUG for the profile used during compilation.
FEATURES|[&str; N]|The features that were enabled during compilation.
FEATURESSTR|&str|The features as a comma-separated string.
GITVERSION|Option<&str>|If the crate was compiled from within a git-repository, GITVERSION contains HEAD's tag. The short commit id is used if HEAD is not tagged.
HOST|&str|The host triple of the rust compiler.
NUMJOBS|u32|The parallelism that was specified during compilation.
OPTLEVEL|&str|Value of OPTLEVEL for the profile used during compilation.
PKGAUTHORS|&str|A colon-separated list of authors.
PKGDESCRIPTION|&str|The description.
PKGHOMEPAGE|&str|The homepage.
PKGNAME|&str|The name of the package.
PKGVERSION|&str|The full version.
PKGVERSIONMAJOR|&str|The major version.
PKGVERSIONMINOR|&str|The minor version.
PKGVERSIONPATCH|&str|The patch version.
PKGVERSIONPRE|&str|The pre-release version.
PROFILE|&str|release for release builds, debug for other builds.
RUSTC|&str|The compiler that cargo resolved to use.
RUSTCVERSION|&str|The output of rustc -V
RUSTDOC|&str|The documentation generator that cargo resolved to use.
RUSTDOC_VERSION|&str|The output of rustdoc -V
- fn get() -> Build
- Build provides a consolidated view of the build-time metadata.
This makes it easier to work with the build-time metadata in a
typesafe manner.
NOTE: The op_build_mod!()
depends on the following dependencies in order to compile: