Struct Git2

pub struct Git2 { /* private fields */ }

The VERGEN_GIT_* configuration features

Variable	Sample
VERGEN_GIT_BRANCH	feature/fun
VERGEN_GIT_COMMIT_AUTHOR_EMAIL	janedoe@email.com
VERGEN_GIT_COMMIT_AUTHOR_NAME	Jane Doe
VERGEN_GIT_COMMIT_COUNT	330
VERGEN_GIT_COMMIT_DATE	2021-02-24
VERGEN_GIT_COMMIT_MESSAGE	feat: add commit messages
VERGEN_GIT_COMMIT_TIMESTAMP	2021-02-24T20:55:21+00:00
VERGEN_GIT_DESCRIBE	5.0.0-2-gf49246c
VERGEN_GIT_SHA	f49246ce334567bff9f950bfd0f3078184a2738a
VERGEN_GIT_DIRTY	true

Example

let git2 = Git2Builder::all_git()?;
Emitter::default().add_instructions(&git2)?.emit()?;

Override output with your own value

temp_env::with_var("VERGEN_GIT_BRANCH", Some("this is the branch I want output"), || {
    let result = || -> Result<()> {
        let git2 = Git2Builder::all_git()?;
        Emitter::default().add_instructions(&git2)?.emit()?;
        Ok(())
    }();
    assert!(result.is_ok());
});

Implementations

impl Git2

pub fn at_path(&mut self, path: PathBuf) -> &mut Self

Use the repository location at the given path to determine the git instruction output.

Trait Implementations

impl Add for Git2

fn add_map_entries( &self, idempotent: bool, cargo_rustc_env: &mut CargoRustcEnvMap, cargo_rerun_if_changed: &mut CargoRerunIfChanged, cargo_warning: &mut CargoWarning, ) -> Result<()>

Try to add instructions entries to the various given arguments.

fn add_default_entries( &self, config: &DefaultConfig, cargo_rustc_env_map: &mut CargoRustcEnvMap, cargo_rerun_if_changed: &mut CargoRerunIfChanged, cargo_warning: &mut CargoWarning, ) -> Result<()>

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

impl Clone for Git2

fn clone(&self) -> Git2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Git2

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

Formats the value using the given formatter.

impl PartialEq for Git2

fn eq(&self, other: &Git2) -> 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 StructuralPartialEq for Git2