Gix

Struct Gix

pub struct Gix { /* private fields */ }

Expand description

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 gix = GixBuilder::all_git()?;
Emitter::default().add_instructions(&gix)?.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 gix = GixBuilder::all_git()?;
        Emitter::default().add_instructions(&gix)?.emit()?;
        Ok(())
    }();
});

Implementations§

impl Gix

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

Run at the given path

Trait Implementations§

impl Add for Gix

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. Read more

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. Read more

impl Clone for Gix

fn clone(&self) -> Gix

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

impl Debug for Gix

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

Formats the value using the given formatter. Read more

impl PartialEq for Gix

fn eq(&self, other: &Gix) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 Gix

Auto Trait Implementations§

impl Freeze for Gix

impl RefUnwindSafe for Gix

impl Send for Gix

impl Sync for Gix

impl Unpin for Gix

impl UnwindSafe for Gix

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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