Struct gix_ref::FullNameRef

#[repr(transparent)]
pub struct FullNameRef(_);

A validated complete and fully qualified referenced reference name, safe to use for all operations.

Implementations

impl FullNameRef

pub fn as_partial_name(&self) -> &PartialNameRef

Interpret this fully qualified reference name as partial name.

pub fn to_path(&self) -> &Path

Convert this name into the relative path identifying the reference location.

pub fn as_bstr(&self) -> &BStr

Return ourselves as byte string which is a valid refname

pub fn shorten(&self) -> &BStr

Strip well-known prefixes from the name and return it.

If there is no such prefix, the original name is returned.

pub fn category(&self) -> Option<Category<'_>>

Classify this name, or return None if it’s unclassified.

pub fn category_and_short_name(&self) -> Option<(Category<'_>, &BStr)>

Classify this name, or return None if it’s unclassified. If Some, the shortened name is returned as well.

impl FullNameRef

pub fn file_name(&self) -> &BStr

Return the file name portion of a full name, for instance main if the full name was refs/heads/main.

Trait Implementations

impl AsRef<FullNameRef> for FullName

fn as_ref(&self) -> &FullNameRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<FullNameRef> for FullName

fn borrow(&self) -> &FullNameRef

Immutably borrows from an owned value.

impl Debug for FullNameRef

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

Formats the value using the given formatter.

impl<'a> From<&'a FullNameRef> for &'a BStr

fn from(name: &'a FullNameRef) -> Self

Converts to this type from the input type.

impl<'a> From<&'a FullNameRef> for &'a PartialNameRef

fn from(v: &'a FullNameRef) -> Self

Converts to this type from the input type.

impl<'a> From<&'a FullNameRef> for FullName

fn from(value: &'a FullNameRef) -> Self

Converts to this type from the input type.

impl Hash for FullNameRef

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

Feeds this value into the given Hasher.

impl Ord for FullNameRef

fn cmp(&self, other: &FullNameRef) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq<FullNameRef> for FullNameRef

fn eq(&self, other: &FullNameRef) -> 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 PartialOrd<FullNameRef> for FullNameRef

fn partial_cmp(&self, other: &FullNameRef) -> 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 ToOwned for FullNameRef

type Owned = FullName

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a BStr> for &'a FullNameRef

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a BStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a String> for &'a FullNameRef

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a String) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for &'a FullNameRef

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FullNameRef

impl StructuralEq for FullNameRef

impl StructuralPartialEq for FullNameRef