Struct Builder 

pub struct Builder { /* private fields */ }

Builder for generating environment/configuration variables.

Implementations

impl Builder

pub const fn lenient_clean(self) -> Self

Categorize as a “clean” build only by checking for uncommitted changes.

By default a clean build requires both no uncommitted changes as well as no untracked files.

pub fn detect_tagged<F>(self, f: F) -> Self

where F: Fn(&str) -> bool + 'static,

Register a closure to be called to determine if a “tagged build” tag is present.

pub fn build(self) -> Status

Set up build environment/cfg variables.

Environment variables

• FSL_PRJCODE - The repository project code.
• FSL_PRJNAME - The repository project name.
• FSL_CHECKOUT_HASH - The checkout’s last commit hash.
• FSL_CHECKOUT_TS - The checkout’s last commit timestamp.
• FSL_CHECKOUT - Set to dirty if the worktree contains uncommitted changes or untracked files. Set to clean otherwise.
• FSL_TAGGED - Set to the tag name if this is a “tagged build”. Not set if this isn’t a tagged build.

cfg variables

• fsl_tagged
  Only set if this is a “tagged build”.
• fsl_checkout = "clean" | "dirty"

Panics

Because this is intended to be used from a build script, all errors are turned into panics.

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.