Enum git_repository::easy::head::Kind

pub enum Kind {
    Symbolic(Reference),
    Unborn(FullName),
    Detached {
        target: ObjectId,
        peeled: Option<ObjectId>,
    },
}

Represents the kind of HEAD reference.

Variants

Symbolic(Reference)

The existing reference the symbolic HEAD points to.

This is the common case.

Unborn(FullName)

The yet-to-be-created reference the symbolic HEAD refers to.

This is the case in a newly initialized repository.

Detached

Fields

target: ObjectId

The object to which the head points to

peeled: Option<ObjectId>

Possibly the final destination of target after following the object chain from tag objects to commits.

The head points to an object directly, not to a symbolic reference.

This state is less common and can occur when checking out commits directly.

Implementations

impl Kind

pub fn attach(self, handle: &Handle) -> Head<'_>

Attach this instance with an access reference to produce a Head.