Enum Head 

pub enum Head {
    Branch {
        name: String,
        oid: Oid,
    },
    Detached {
        oid: Oid,
    },
}

Represents the current HEAD state of a Git repository.

HEAD can either point to a branch (normal state) or directly to a commit (detached HEAD state).

Variants

Branch

HEAD points to a branch (e.g., refs/heads/main).

Fields

name: String

The branch name (without refs/heads/ prefix).

oid: Oid

The commit OID the branch points to.

Detached

HEAD points directly to a commit (detached state).

Fields

oid: Oid

The commit OID that HEAD points to.

Implementations

impl Head

pub fn branch(name: impl Into<String>, oid: Oid) -> Self

Creates a new Head pointing to a branch.

Arguments

• name - The branch name (without refs/heads/ prefix).
• oid - The commit OID the branch points to.

pub fn detached(oid: Oid) -> Self

Creates a new detached Head.

Arguments

• oid - The commit OID that HEAD points to.

pub fn oid(&self) -> &Oid

Returns the commit OID that HEAD points to.

This works for both branch and detached states.

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

Returns the branch name if HEAD points to a branch.

Returns None if HEAD is in detached state.

pub fn is_detached(&self) -> bool

Returns true if HEAD is in detached state.

pub fn is_branch(&self) -> bool

Returns true if HEAD points to a branch.

pub fn reference_name(&self) -> String

Returns the full reference name.

For branches, returns refs/heads/<name>. For detached HEAD, returns the commit OID as hex.

Trait Implementations

impl Clone for Head

fn clone(&self) -> Head

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Head

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

Formats the value using the given formatter.

impl PartialEq for Head

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

impl StructuralPartialEq for Head