Struct vergen::Build

pub struct Build { /* private fields */ }

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

impl Build

pub fn enabled_mut(&mut self) -> &mut bool

Enable/Disable the build output

pub fn timestamp_mut(&mut self) -> &mut bool

Enable/Disable the VERGEN_BUILD_DATE, VERGEN_BUILD_TIME, and VERGEN_BUILD_TIMESTAMP instructions.

pub fn timezone_mut(&mut self) -> &mut TimeZone

The timezone to use for the date/time instructions.

pub fn kind_mut(&mut self) -> &mut TimestampKind

The kind of date/time instructions to output.

pub fn semver_mut(&mut self) -> &mut bool

Enable/Disable the VERGEN_BUILD_SEMVER instruction.

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.

Trait Implementations

impl Clone for Build

fn clone(&self) -> Build

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Build

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Build

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Build