Struct build_info_common::GitInfo

pub struct GitInfo {
    pub commit_id: String,
    pub commit_short_id: String,
    pub commit_timestamp: DateTime<Utc>,
    pub dirty: bool,
    pub branch: Option<String>,
    pub tags: Vec<String>,
}

Information about a git repository

If a git repository is detected (and, thereby, this information included), the build script will be rerun whenever the currently checked out commit changes.

Fields

commit_id: String

Full commit hash for the currently checked out commit

commit_short_id: String

Short commit hash for the currently checked out commit

The length of this string depends on the effective value of the git configuration variable core.abbrev, and is extended to the minimum length required for the id to be unique (at the time it was computed).

commit_timestamp: DateTime<Utc>

Timestamp of the currently checked out commit

dirty: bool

true iff the repository had uncommitted changes when building the project.

branch: Option<String>

Names the branch that is currently checked out, if any

tags: Vec<String>

All tags that point to the current commit (e.g., ["v0.0.10", "sample@v0.0.10"])

Trait Implementations

impl Clone for GitInfo

pub fn clone(&self) -> GitInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GitInfo

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

Formats the value using the given formatter.

impl Display for GitInfo

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

Formats the value using the given formatter.

impl Eq for GitInfo

impl Hash for GitInfo

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for GitInfo

pub fn cmp(&self, other: &GitInfo) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GitInfo> for GitInfo

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GitInfo) -> bool

This method tests for !=.

impl PartialOrd<GitInfo> for GitInfo

pub fn partial_cmp(&self, other: &GitInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &GitInfo) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &GitInfo) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &GitInfo) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &GitInfo) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for GitInfo

impl StructuralPartialEq for GitInfo