Struct RefSpecRef 

pub struct RefSpecRef<'a> { /* private fields */ }

A refspec with references to the memory it was parsed from.

Implementations

impl<'a> RefSpecRef<'a>

Access

pub fn source(&self) -> Option<&BStr>

Return the left-hand side of the spec, typically the source. It takes many different forms so don’t rely on this being a ref name.

It’s not present in case of deletions.

pub fn destination(&self) -> Option<&BStr>

Return the right-hand side of the spec, typically the destination ref name or ref pattern.

It’s not present in case of source-only specs.

pub fn remote(&self) -> Option<&BStr>

Return the explicitly stored remote side, whose position depends on how the refspec was parsed.

A one-sided push refspec has no explicit remote side and returns None here, even though its source is later also used as its destination.

pub fn local(&self) -> Option<&BStr>

Return the explicitly stored local side, whose position depends on how the refspec was parsed.

pub fn prefix(&self) -> Option<&BStr>

Derive the prefix from the source side of this spec if this is a fetch spec, or the destination side if it is a push spec, if it is possible to do so without ambiguity.

Exact refs starting with refs/ are returned unchanged, like refs/heads/main or refs/namespaces/foo/refs/heads/main. Git-style ref patterns return the fixed portion before their single * when it is more specific than refs/: both refs/heads/* and refs/heads/*/suffix yield refs/heads/. Negative refspecs and one-sided push refspecs return None.

pub fn expand_prefixes(&self, out: &mut Vec<BString>)

Append the remote-ref prefixes represented by this refspec to out, suitable for limiting the refs requested from a remote. Unlike prefix(), partial names without an unambiguous prefix are expanded to all of their Git-style ref-name candidates. For example, main expands to main, refs/main, refs/tags/main, refs/heads/main, refs/remotes/main, and refs/remotes/main/HEAD.

Fetch refspecs use their source; push refspecs use their explicit destination. Negative refspecs produce no prefixes because they only exclude refs selected by positive refspecs; they do not request remote refs.

pub fn instruction(&self) -> Instruction<'a>

Transform the state of the refspec into an instruction making clear what to do with it.

impl RefSpecRef<'_>

Conversion

pub fn to_owned(&self) -> RefSpec

Convert this ref into a standalone, owned copy.

impl RefSpecRef<'_>

pub fn to_bstring(&self) -> BString

Reproduce ourselves in parseable form.

pub fn write_to(&self, out: &mut dyn Write) -> Result<()>

Serialize ourselves in a parseable format to out.

Trait Implementations

impl<'a> Clone for RefSpecRef<'a>

fn clone(&self) -> RefSpecRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RefSpecRef<'a>

impl<'a> Debug for RefSpecRef<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for RefSpecRef<'a>

impl From<RefSpecRef<'_>> for RefSpec

fn from(v: RefSpecRef<'_>) -> Self

Converts to this type from the input type.

impl Hash for RefSpecRef<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RefSpecRef<'_>

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for RefSpecRef<'_>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RefSpecRef<'_>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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