Struct git_repository::Reference

pub struct Reference<'r> {
    pub inner: Reference,
    /* private fields */
}

A reference that points to an object or reference, with access to its source repository.

Note that these are snapshots and won’t recognize if they are stale.

Fields

inner: Reference

The actual reference data

Implementations

impl<'repo> Reference<'repo>

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

Return a platform for obtaining iterators over reference logs.

impl<'repo> Reference<'repo>

Access

pub fn target(&self) -> TargetRef<'_>

Return the target to which this reference points to.

pub fn name(&self) -> &FullNameRef

Return the reference’s full name.

pub fn detach(self) -> Reference

Turn this instances into a stand-alone reference.

impl<'repo> Reference<'repo>

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

Returns the attached id we point to, or None if this is a symbolic ref.

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

Returns the attached id we point to, or panic if this is a symbolic ref.

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

Follow all symbolic targets this reference might point to and peel the underlying object to the end of the chain, and return it.

This is useful to learn where this reference is ulitmately pointing to.

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

Similar to peel_to_id_in_place(), but consumes this instance.

Trait Implementations

impl<'repo> Debug for Reference<'repo>

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

Formats the value using the given formatter.