Struct git2::Reference

pub struct Reference<'repo> { /* private fields */ }

A structure to represent a git reference.

Implementations

impl<'repo> Reference<'repo>

pub fn is_valid_name(refname: &str) -> bool

Ensure the reference name is well-formed.

Validation is performed as if ReferenceFormat::ALLOW_ONELEVEL was given to Reference::normalize_name. No normalization is performed, however.

use git2::Reference;

assert!(Reference::is_valid_name("HEAD"));
assert!(Reference::is_valid_name("refs/heads/main"));

// But:
assert!(!Reference::is_valid_name("main"));
assert!(!Reference::is_valid_name("refs/heads/*"));
assert!(!Reference::is_valid_name("foo//bar"));

pub fn normalize_name( refname: &str, flags: ReferenceFormat, ) -> Result<String, Error>

Normalize reference name and check validity.

This will normalize the reference name by collapsing runs of adjacent slashes between name components into a single slash. It also validates the name according to the following rules:

1. If ReferenceFormat::ALLOW_ONELEVEL is given, the name may contain only capital letters and underscores, and must begin and end with a letter. (e.g. “HEAD”, “ORIG_HEAD”).
2. The flag ReferenceFormat::REFSPEC_SHORTHAND has an effect only when combined with ReferenceFormat::ALLOW_ONELEVEL. If it is given, “shorthand” branch names (i.e. those not prefixed by refs/, but consisting of a single word without / separators) become valid. For example, “main” would be accepted.
3. If ReferenceFormat::REFSPEC_PATTERN is given, the name may contain a single * in place of a full pathname component (e.g. foo/*/bar, foo/bar*).
4. Names prefixed with “refs/” can be almost anything. You must avoid the characters ‘~’, ‘^’, ‘:’, ‘\’, ‘?’, ‘[’, and ‘*’, and the sequences “..” and “@{” which have special meaning to revparse.

If the reference passes validation, it is returned in normalized form, otherwise an Error with ErrorCode::InvalidSpec is returned.

use git2::{Reference, ReferenceFormat};

assert_eq!(
    Reference::normalize_name(
        "foo//bar",
        ReferenceFormat::NORMAL
    )
    .unwrap(),
    "foo/bar".to_owned()
);

assert_eq!(
    Reference::normalize_name(
        "HEAD",
        ReferenceFormat::ALLOW_ONELEVEL
    )
    .unwrap(),
    "HEAD".to_owned()
);

assert_eq!(
    Reference::normalize_name(
        "refs/heads/*",
        ReferenceFormat::REFSPEC_PATTERN
    )
    .unwrap(),
    "refs/heads/*".to_owned()
);

assert_eq!(
    Reference::normalize_name(
        "main",
        ReferenceFormat::ALLOW_ONELEVEL | ReferenceFormat::REFSPEC_SHORTHAND
    )
    .unwrap(),
    "main".to_owned()
);

pub fn raw(&self) -> *mut git_reference

Get access to the underlying raw pointer.

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

Delete an existing reference.

This method works for both direct and symbolic references. The reference will be immediately removed on disk.

This function will return an error if the reference has changed from the time it was looked up.

pub fn is_branch(&self) -> bool

Check if a reference is a local branch.

pub fn is_note(&self) -> bool

Check if a reference is a note.

pub fn is_remote(&self) -> bool

Check if a reference is a remote tracking branch

pub fn is_tag(&self) -> bool

Check if a reference is a tag

pub fn kind(&self) -> Option<ReferenceType>

Get the reference type of a reference.

If the type is unknown, then None is returned.

pub fn name(&self) -> Option<&str>

Get the full name of a reference.

Returns None if the name is not valid utf-8.

pub fn name_bytes(&self) -> &[u8]

Get the full name of a reference.

pub fn shorthand(&self) -> Option<&str>

Get the full shorthand of a reference.

This will transform the reference name into a name “human-readable” version. If no shortname is appropriate, it will return the full name.

Returns None if the shorthand is not valid utf-8.

pub fn shorthand_bytes(&self) -> &[u8]

Get the full shorthand of a reference.

pub fn target(&self) -> Option<Oid>

Get the OID pointed to by a direct reference.

Only available if the reference is direct (i.e. an object id reference, not a symbolic one).

pub fn target_peel(&self) -> Option<Oid>

Return the peeled OID target of this reference.

This peeled OID only applies to direct references that point to a hard Tag object: it is the result of peeling such Tag.

pub fn symbolic_target(&self) -> Option<&str>

Get full name to the reference pointed to by a symbolic reference.

May return None if the reference is either not symbolic or not a valid utf-8 string.

pub fn symbolic_target_bytes(&self) -> Option<&[u8]>

Get full name to the reference pointed to by a symbolic reference.

Only available if the reference is symbolic.

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

Resolve a symbolic reference to a direct reference.

This method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.

If a direct reference is passed as an argument, a copy of that reference is returned.

pub fn peel(&self, kind: ObjectType) -> Result<Object<'repo>, Error>

Peel a reference to an object

This method recursively peels the reference until it reaches an object of the specified type.

pub fn peel_to_blob(&self) -> Result<Blob<'repo>, Error>

Peel a reference to a blob

This method recursively peels the reference until it reaches a blob.

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

Peel a reference to a commit

This method recursively peels the reference until it reaches a commit.

pub fn peel_to_tree(&self) -> Result<Tree<'repo>, Error>

Peel a reference to a tree

This method recursively peels the reference until it reaches a tree.

pub fn peel_to_tag(&self) -> Result<Tag<'repo>, Error>

Peel a reference to a tag

This method recursively peels the reference until it reaches a tag.

pub fn rename( &mut self, new_name: &str, force: bool, msg: &str, ) -> Result<Reference<'repo>, Error>

Rename an existing reference.

This method works for both direct and symbolic references.

If the force flag is not enabled, and there’s already a reference with the given name, the renaming will fail.

pub fn set_target( &mut self, id: Oid, reflog_msg: &str, ) -> Result<Reference<'repo>, Error>

Conditionally create a new reference with the same name as the given reference but a different OID target. The reference must be a direct reference, otherwise this will fail.

The new reference will be written to disk, overwriting the given reference.

pub fn symbolic_set_target( &mut self, target: &str, reflog_msg: &str, ) -> Result<Reference<'repo>, Error>

Create a new reference with the same name as the given reference but a different symbolic target. The reference must be a symbolic reference, otherwise this will fail.

The new reference will be written to disk, overwriting the given reference.

The target name will be checked for validity. See Repository::reference_symbolic for rules about valid names.

The message for the reflog will be ignored if the reference does not belong in the standard set (HEAD, branches and remote-tracking branches) and it does not have a reflog.

Trait Implementations

impl<'repo> Drop for Reference<'repo>

fn drop(&mut self)

Executes the destructor for this type.

impl<'repo> Ord for Reference<'repo>

fn cmp(&self, other: &Reference<'repo>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'repo> PartialEq for Reference<'repo>

fn eq(&self, other: &Reference<'repo>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'repo> PartialOrd for Reference<'repo>

fn partial_cmp(&self, other: &Reference<'repo>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'repo> Eq for Reference<'repo>