Enum HeadState 

pub enum HeadState {
    Branch {
        refname: String,
        short_name: String,
        oid: Option<ObjectId>,
    },
    Detached {
        oid: ObjectId,
    },
    Invalid,
}

The current state of HEAD.

Variants

Branch

HEAD points to a branch via a symbolic ref (e.g. ref: refs/heads/main).

Fields

refname: String

The full ref name (e.g. refs/heads/main).

short_name: String

The short branch name (e.g. main).

oid: Option<ObjectId>

The commit OID that the branch points to, or None if the branch is unborn (no commits yet).

Detached

HEAD is detached — pointing directly at a commit.

Fields

oid: ObjectId

The commit OID.

Invalid

HEAD is in an invalid or unreadable state.

Implementations

impl HeadState

pub fn oid(&self) -> Option<&ObjectId>

Return the commit OID if HEAD resolves to one.

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

Return the branch name if HEAD is on a branch.

pub fn is_unborn(&self) -> bool

Whether HEAD is on an unborn branch (no commits yet).

pub fn is_detached(&self) -> bool

Whether HEAD is detached.

pub fn tree(&self, odb: &Odb) -> Result<Option<ObjectId>>

The root tree of the commit this state names.

Use this when an unreadable HEAD should be treated like an unborn branch (for example to diff the index against “nothing”); use Repository::head_tree when it must be an error.

Parameters

• odb: the object database holding the commit.

Returns

Some(tree) when Self::oid names a commit, None on an unborn branch or an HeadState::Invalid HEAD.

Errors

Same as Odb::commit_tree: the commit is missing, is not a commit, or has no valid tree header.

Trait Implementations

impl Clone for HeadState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeadState

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

Formats the value using the given formatter.

impl Eq for HeadState

impl PartialEq for HeadState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HeadState