Struct vergen::Build

pub struct Build { /* fields omitted */ }

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.

Example

use vergen::{vergen, Config};
use vergen::{TimestampKind, TimeZone};

let mut config = Config::default();
// Generate all three date/time instructions
*config.build_mut().kind_mut() = TimestampKind::All;
// Change the date/time instructions to show `Local` time
*config.build_mut().timezone_mut() = TimeZone::Local;

// Generate the instructions
vergen(config)?;

Implementations

impl Build

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.

Trait Implementations

impl Clone for Build

fn clone(&self) -> Build

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Build

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.