Struct GitContext 

pub struct GitContext {
    pub commit: Option<String>,
    pub branch: Option<String>,
    pub tag: Option<String>,
    pub dirty: Option<bool>,
}

Git context at the time of publishing.

Captures the current git state, including commit hash, branch, tag, and whether the working directory is dirty.

Example

use shipper::types::GitContext;

let ctx = GitContext {
    commit: Some("abc123def".to_string()),
    branch: Some("main".to_string()),
    tag: Some("v1.0.0".to_string()),
    dirty: Some(false),
};

Fields

commit: Option<String>

branch: Option<String>

tag: Option<String>

dirty: Option<bool>

Implementations

impl GitContext

pub fn new() -> Self

Create a new empty git context.

pub fn has_commit(&self) -> bool

Whether the context has commit information.

pub fn is_dirty(&self) -> bool

Whether the working tree is dirty.

When dirty is None, this defaults to true (treat unknown as dirty) to preserve the safe-by-default semantics of the original shipper-git crate.

pub fn short_commit(&self) -> Option<&str>

Get a short commit hash (first 7 bytes).

Returns None if the context has no commit. The original shipper-git implementation sliced by byte index assuming ASCII hex; we preserve the same behavior here (input shorter than 7 bytes is returned verbatim).

Trait Implementations

impl Clone for GitContext

fn clone(&self) -> GitContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitContext

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

Formats the value using the given formatter.

impl Default for GitContext

fn default() -> GitContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GitContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GitContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.