Enum GitHead 

pub enum GitHead {
    Symbolic(SymbolicRef),
    Detached(String),
    Unborn,
}

A lightweight HEAD vocabulary value.

Variants

Symbolic(SymbolicRef)

HEAD exists as a symbolic ref.

Detached(String)

HEAD names object identifier text directly.

Unborn

HEAD is known as vocabulary, but no target is modeled.

Implementations

impl GitHead

pub const fn symbolic(target: GitRefName) -> GitHead

Creates symbolic HEAD from a target ref name.

pub fn detached(value: impl AsRef<str>) -> Result<GitHead, GitRefParseError>

Creates detached HEAD from object identifier text.

Errors

Returns GitRefParseError::EmptyDetachedTarget when the supplied text is empty.

pub const fn is_symbolic(&self) -> bool

Returns true when HEAD is symbolic.

pub const fn is_detached(&self) -> bool

Returns true when HEAD is detached.

pub const fn symbolic_ref(&self) -> Option<&SymbolicRef>

Returns the symbolic target when present.

Trait Implementations

impl Clone for GitHead

fn clone(&self) -> GitHead

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitHead

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

Formats the value using the given formatter.

impl PartialEq for GitHead

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

impl StructuralPartialEq for GitHead