Struct Git2Builder

Source
pub struct Git2Builder { /* private fields */ }
Expand description

Builder for Git2.

Implementations§

Source§

impl Git2Builder

Source

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

An optional path to a repository.

Source

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

Emit the current git branch

cargo:rustc-env=VERGEN_GIT_BRANCH=<BRANCH_NAME>
Source

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>
Source

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>
Source

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>
Source

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>
Source

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>
Source

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>
Source

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

Enable local offset date/timestamp output

Source

pub fn build(&self) -> Result<Git2, Git2BuilderError>

Builds a new Git2.

§Errors

If a required field has not been initialized.

Source§

impl Git2Builder

Source

pub fn all_git() -> Result<Git2>

Emit all of the VERGEN_GIT_* instructions

§Errors

The underlying build function can error

Source

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

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

Source

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

Source

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.

Source

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§

Source§

impl Clone for Git2Builder

Source§

fn clone(&self) -> Git2Builder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Git2Builder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,