Struct vergen_gitcl::GitclBuilder

pub struct GitclBuilder { /* private fields */ }

Builder for Gitcl.

Implementations

impl GitclBuilder

pub fn repo_path(&mut self, value: Option<PathBuf>) -> &mut Self

An optional path to a repository.

pub fn branch(&mut self, value: bool) -> &mut Self

Emit the current git branch

cargo:rustc-env=VERGEN_GIT_BRANCH=<BRANCH_NAME>

pub fn commit_author_name(&mut self, value: bool) -> &mut Self

Emit the author email of the most recent commit

cargo:rustc-env=VERGEN_GIT_COMMIT_AUTHOR_EMAIL=<AUTHOR_EMAIL>

pub fn commit_author_email(&mut self, value: bool) -> &mut Self

Emit the author name of the most recent commit

cargo:rustc-env=VERGEN_GIT_COMMIT_AUTHOR_NAME=<AUTHOR_NAME>

pub fn commit_count(&mut self, value: bool) -> &mut Self

Emit the total commit count to HEAD

cargo:rustc-env=VERGEN_GIT_COMMIT_COUNT=<COUNT>

pub fn commit_message(&mut self, value: bool) -> &mut Self

Emit the commit message of the latest commit

cargo:rustc-env=VERGEN_GIT_COMMIT_MESSAGE=<MESSAGE>

pub fn commit_date(&mut self, value: bool) -> &mut Self

Emit the commit date of the latest commit

cargo:rustc-env=VERGEN_GIT_COMMIT_DATE=<YYYY-MM-DD>

The value is determined with the following command

git log -1 --pretty=format:'%cs'

pub fn commit_timestamp(&mut self, value: bool) -> &mut Self

Emit the commit timestamp of the latest commit

cargo:rustc-env=VERGEN_GIT_COMMIT_TIMESTAMP=<YYYY-MM-DDThh:mm:ssZ>

pub fn use_local(&mut self, value: bool) -> &mut Self

Enable local offset date/timestamp output

pub fn git_cmd(&mut self, value: Option<&'static str>) -> &mut Self

Specify the git cmd you wish to use, i.e. /usr/bin/git

pub fn build(&self) -> Result<Gitcl, GitclBuilderError>

Builds a new Gitcl.

Errors

If a required field has not been initialized.

impl GitclBuilder

pub fn all_git() -> Result<Gitcl>

Emit all of the VERGEN_GIT_* instructions

Errors

The underlying build function can error

pub fn all(&mut self) -> &mut Self

Convenience method to setup the GitclBuilder with all of the VERGEN_GIT_* instructions on

pub fn describe( &mut self, tags: bool, dirty: bool, matches: Option<&'static str>, ) -> &mut Self

Emit the describe output

cargo:rustc-env=VERGEN_GIT_DESCRIBE=<DESCRIBE>

Optionally, add the dirty or tags flag to describe. See git describe for more details

pub fn dirty(&mut self, include_untracked: bool) -> &mut Self

Emit the dirty state of the git repository

cargo:rustc-env=VERGEN_GIT_DIRTY=(true|false)

Optionally, include untracked files when determining the dirty status of the repository.

pub fn sha(&mut self, short: bool) -> &mut Self

Emit the SHA of the latest commit

cargo:rustc-env=VERGEN_GIT_SHA=<SHA>

Optionally, add the short flag to rev-parse. See git rev-parse for more details.

Trait Implementations

impl Clone for GitclBuilder

fn clone(&self) -> GitclBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for GitclBuilder

fn default() -> Self

Returns the “default value” for a type.