Struct git_repository::Head

pub struct Head<'repo> {
    pub kind: Kind,
    /* private fields */
}

The head reference, as created from looking at .git/HEAD, able to represent all of its possible states.

Note that like Reference, this type’s data is snapshot of persisted state on disk.

Fields

kind: Kind

One of various possible states for the HEAD reference

Implementations

impl<'repo> Head<'repo>

pub fn log_iter(&self) -> Platform<'static, '_>

Return a platform for obtaining iterators on the reference log associated with the HEAD reference.

impl<'repo> Head<'repo>

pub fn peeled(self) -> Result<Self, Error>

Peel this instance to make obtaining its final target id possible, while returning an error on unborn heads.

pub fn peel_to_id_in_place(&mut self) -> Option<Result<Id<'repo>, Error>>

Follow the symbolic reference of this head until its target object and peel it by following tag objects until there is no more object to follow, and return that object id.

Returns None if the head is unborn.

pub fn peel_to_commit_in_place(&mut self) -> Result<Commit<'repo>, Error>

Follow the symbolic reference of this head until its target object and peel it by following tag objects until there is no more object to follow, transform the id into a commit if possible and return that.

Returns an error if the head is unborn or if it doesn’t point to a commit.

pub fn into_fully_peeled_id(self) -> Option<Result<Id<'repo>, Error>>

Consume this instance and transform it into the final object that it points to, or None if the HEAD reference is yet to be born.

impl<'repo> Head<'repo>

pub fn name(&self) -> &'static FullNameRef

Returns the name of this references, always HEAD.

pub fn referent_name(&self) -> Option<&FullNameRef>

Returns the full reference name of this head if it is not detached, or None otherwise.

pub fn is_detached(&self) -> bool

Returns true if this instance is detached, and points to an object directly.

pub fn id(&self) -> Option<Id<'repo>>

Returns the id the head points to, which isn’t possible on unborn heads.

pub fn into_referent(self) -> Reference<'repo>

Force transforming this instance into the symbolic reference that it points to, or panic if it is unborn or detached.

Panics

If this isn’t actually a head pointing to a symbolic reference.