Struct gix::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>

Remote

pub fn into_remote( self, direction: Direction ) -> Option<Result<Remote<'repo>, Error>>

Return the remote with which the currently checked our reference can be handled as configured by branch.<name>.remote|pushRemote or fall back to the non-branch specific remote configuration. None is returned if the head is detached or unborn, so there is no branch specific remote.

This is equivalent to calling Reference::remote(…) and Repository::remote_default_name() in order.

Combine it with Repository::find_default_remote() as fallback to handle detached heads, i.e. obtain a remote even in case of detached heads, or call Repository::find_fetch_remote(…) for the highest-level way of finding the right remote, just like git fetch does.

impl<'repo> Head<'repo>

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

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

pub fn prior_checked_out_branches( &self ) -> Result<Option<Vec<(BString, ObjectId)>>>

Return a list of all branch names that were previously checked out with the first-ever checked out branch being the first entry of the list, and the most recent is the last, along with the commit they were pointing to at the time.

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>

Access

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 is_unborn(&self) -> bool

Returns true if this instance is not yet born, hence it points to a ref that doesn’t exist yet.

This is the case in a newly initialized repository.

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

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

pub fn try_into_referent(self) -> Option<Reference<'repo>>

Try to transform this instance into the symbolic reference that it points to, or return None if head is detached or unborn.

Trait Implementations

impl<'repo> Clone for Head<'repo>

fn clone(&self) -> Head<'repo>

Returns a copy of the value.

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

Performs copy-assignment from source.