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

Remotes

pub fn remote_name(&self, direction: Direction) -> Option<Name<'repo>>

Find the unvalidated name of our remote for direction as configured in branch.<name>.remote|pushRemote respectively. If Some(<name>) it can be used in Repository::find_remote(…), or if None then Repository::remote_default_name() could be used in its place.

Return None if no remote is configured.

Note

• it’s recommended to use the remote(…) method as it will configure the remote with additional information.
• branch.<name>.pushRemote falls back to branch.<name>.remote.

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

Like remote_name(…), but configures the returned Remote with additional information like

• branch.<name>.merge to know which branch on the remote side corresponds to this one for merging when pulling.

It also handles if the remote is a configured URL, which has no name.

impl<'repo> Reference<'repo>

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

Return a platform for obtaining iterators over reference logs.

pub fn log_exists(&self) -> bool

Return true if a reflog is present for this reference.

impl<'repo> Reference<'repo>

pub fn set_target_id( &mut self, id: impl Into<ObjectId>, reflog_message: impl Into<BString> ) -> Result<(), Error>

Set the id of this direct reference to id and use reflog_message for the reflog (if enabled in the repository).

Note that the operation will fail on symbolic references, to change their type use the lower level reference database, or if the reference was deleted or changed in the mean time. Furthermore, refrain from using this method for more than a one-off change as it creates a transaction for each invocation. If multiple reference should be changed, use Repository::edit_references() or the lower level reference database instead.

impl<'repo> Reference<'repo>

pub fn delete(&self) -> Result<(), Error>

Delete this reference or fail if it was changed since last observed. Note that this instance remains available in memory but probably shouldn’t be used anymore.

impl<'repo> Reference<'repo>

Access

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 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>

Peeling

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 ultimately pointing to.

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

Similar to peel_to_id_in_place(), but consumes this instance.

pub fn follow(&self) -> Option<Result<Reference<'repo>, Error>>

Follow this symbolic reference one level and return the ref it refers to.

Returns None if this is not a symbolic reference, hence the leaf of the chain.

Trait Implementations

impl<'r> Clone for Reference<'r>

fn clone(&self) -> Reference<'r>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.