Struct gix_refspec::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. It takes many different forms so don’t rely on this being a ref name.

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

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

Always returns the remote side, whose actual side in the refspec depends on how it was parsed.

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

Always returns the local side, whose actual side in the refspec depends on how it 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.

This means it starts with refs/. Note that it won’t contain more than two components, like refs/heads/

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

As opposed to prefix(), if the latter is None it will expand to all possible prefixes and place them in out.

Note that only the source side is considered.

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 copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RefSpecRef<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

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.

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

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