Struct Build 

pub struct Build { /* private fields */ }

Available on crate feature build only.

The VERGEN_BUILD_* configuration features

Variable	Sample
VERGEN_BUILD_DATE	2021-02-25
VERGEN_BUILD_TIMESTAMP	2021-02-25T23:28:39.493201+00:00

Example

Emit all of the build instructions

let build = Build::all_build();
Emitter::new().add_instructions(&build)?.emit()?;

Emit some of the build instructions

let build = Build::builder().build_timestamp(true).build();
Emitter::new().add_instructions(&build)?.emit()?;

Override output with your own value

temp_env::with_var("VERGEN_BUILD_DATE", Some("01/01/2023"), || {
    let result = || -> Result<()> {
        let build = Build::builder().build_date(true).build();
        Emitter::new().add_instructions(&build)?.emit()?;
        Ok(())
    }();
    assert!(result.is_ok());
});

Example

This feature can also be used in conjuction with the SOURCE_DATE_EPOCH environment variable to generate deterministic timestamps based off the last modification time of the source/package

temp_env::with_var("SOURCE_DATE_EPOCH", Some("1671809360"), || {
    let result = || -> Result<()> {
        let build = Build::all_build();
        Emitter::new().add_instructions(&build)?.emit()?;
        Ok(())
    }();
});

The above will always generate the following output for the timestamp related instructions

cargo:rustc-env=VERGEN_BUILD_DATE=2022-12-23
cargo:rustc-env=VERGEN_BUILD_TIMESTAMP=2022-12-23T15:29:20.000000000Z

Example

This feature also recognizes the idempotent flag.

NOTE - SOURCE_DATE_EPOCH takes precedence over the idempotent flag. If you use both, the output will be based off SOURCE_DATE_EPOCH. This would still be deterministic.

let build = Build::builder().build();
Emitter::new().idempotent().add_instructions(&build)?.emit()?;

The above will always generate the following output for the timestamp related instructions unless you also use quiet, then the warnings will be suppressed.

cargo:rustc-env=VERGEN_BUILD_DATE=VERGEN_IDEMPOTENT_OUTPUT
cargo:rustc-env=VERGEN_BUILD_TIMESTAMP=VERGEN_IDEMPOTENT_OUTPUT
cargo:warning=VERGEN_BUILD_DATE set to default
cargo:warning=VERGEN_BUILD_TIMESTAMP set to default
cargo:rerun-if-changed=build.rs
cargo:rerun-if-env-changed=VERGEN_IDEMPOTENT
cargo:rerun-if-env-changed=SOURCE_DATE_EPOCH

Implementations

impl Build

pub fn builder() -> BuildBuilder

Create an instance of Build using the builder syntax

impl Build

pub fn all_build() -> Build

Enable all of the VERGEN_BUILD_* options

Errors

The build function can error

Trait Implementations

impl Add for Build

fn add_map_entries( &self, idempotent: bool, cargo_rustc_env: &mut BTreeMap<VergenKey, String>, _cargo_rerun_if_changed: &mut Vec<String>, cargo_warning: &mut Vec<String>, ) -> Result<(), Error>

Try to add instructions entries to the various given arguments.

fn add_default_entries( &self, config: &DefaultConfig, cargo_rustc_env_map: &mut BTreeMap<VergenKey, String>, _cargo_rerun_if_changed: &mut Vec<String>, cargo_warning: &mut Vec<String>, ) -> Result<(), Error>

Based on the given configuration, emit either default idempotent output or generate a failue.

impl Clone for Build

fn clone(&self) -> Build

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl PartialEq for Build

fn eq(&self, other: &Build) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Build

impl StructuralPartialEq for Build