Enum Head 

#[non_exhaustive]
pub enum Head {
    Branch(String),
    Detached(ObjectId),
    Unborn {
        symbolic_ref: String,
    },
    OtherRef {
        full_name: String,
    },
}

Resolved HEAD state.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Branch(String)

HEAD → refs/heads/<name> with at least one commit. The String is the short name (prefix stripped).

Detached(ObjectId)

Detached HEAD at a specific object.

Unborn

Fresh git init with no commits. symbolic_ref is the short name HEAD points at (whatever init.defaultBranch resolves to).

Fields

symbolic_ref: String

OtherRef

HEAD points at a ref outside refs/heads/ (e.g. a remote- tracking ref or a tag). full_name is the unstripped refname.

Fields

full_name: String

Implementations

impl Head

pub fn kind_str(&self) -> &'static str

Short plugin-facing tag used in the rhai ctx mirror.

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