pub struct Build { /* private fields */ }
Expand description
Configuration for the VERGEN_BUILD_*
instructions
Instructions
The following instructions can be generated:
Instruction | Default |
---|---|
cargo:rustc-env=VERGEN_BUILD_DATE=2021-02-12 | |
cargo:rustc-env=VERGEN_BUILD_TIME=11:22:34 | |
cargo:rustc-env=VERGEN_BUILD_TIMESTAMP=2021-02-12T01:54:15.134750+00:00 | * |
cargo:rustc-env=VERGEN_BUILD_SEMVER=4.2.0 | * |
- If the
timestamp
field is false, the date/time instructions will not be generated. - If the
semver
field is false, the semver instruction will not be generated. - NOTE - By default, the date/time related instructions will use
UTC
. - NOTE - The date/time instruction output is determined by the
kind
field and can be any combination of the three. - NOTE - To keep processing other sections if an Error occurs in this one, set
Build::skip_if_error
to true. - NOTE - If the
SOURCE_DATE_EPOCH
environment variable is set, vergen will use the value of that variable in place of the current time.
Example
use vergen::{vergen, Config};
use vergen::TimestampKind;
let mut config = Config::default();
// Generate all three date/time instructions
*config.build_mut().kind_mut() = TimestampKind::All;
// Generate the instructions
vergen(config)?;
Implementations§
source§impl Build
impl Build
sourcepub fn enabled_mut(&mut self) -> &mut bool
pub fn enabled_mut(&mut self) -> &mut bool
Enable/Disable the build output
sourcepub fn timestamp_mut(&mut self) -> &mut bool
pub fn timestamp_mut(&mut self) -> &mut bool
Enable/Disable the VERGEN_BUILD_DATE
, VERGEN_BUILD_TIME
, and VERGEN_BUILD_TIMESTAMP
instructions.
sourcepub fn timezone_mut(&mut self) -> &mut TimeZone
pub fn timezone_mut(&mut self) -> &mut TimeZone
The timezone to use for the date/time instructions.
sourcepub fn kind_mut(&mut self) -> &mut TimestampKind
pub fn kind_mut(&mut self) -> &mut TimestampKind
The kind of date/time instructions to output.
sourcepub fn semver_mut(&mut self) -> &mut bool
pub fn semver_mut(&mut self) -> &mut bool
Enable/Disable the VERGEN_BUILD_SEMVER
instruction.
sourcepub fn skip_if_error_mut(&mut self) -> &mut bool
pub fn skip_if_error_mut(&mut self) -> &mut bool
Enable/Disable skipping Build
if an Error occurs.
Use option_env!
to read the generated environment variables.