Struct gix_ref::FullName

pub struct FullName(/* private fields */);

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

Implementations

impl FullName

pub fn to_path(&self) -> &Path

Convert this name into the relative path, lossily, identifying the reference location relative to a repository

pub fn into_inner(self) -> BString

Dissolve this instance and return the buffer.

pub fn as_bstr(&self) -> &BStr

Return ourselves as byte string which is a valid refname

pub fn prefix_namespace(&mut self, namespace: &Namespace) -> &mut Self

Modify ourself so that we use namespace as prefix, if it is not yet in the namespace

pub fn strip_namespace(&mut self, namespace: &Namespace) -> &mut Self

Strip the given namespace off the beginning of this name, if it is in this namespace.

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.

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 Clone for FullName

fn clone(&self) -> FullName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FullName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FullName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FullName

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<FullName> for BString

fn from(name: FullName) -> Self

Converts to this type from the input type.

impl From<FullName> for Target

fn from(name: FullName) -> Self

Converts to this type from the input type.

impl Hash for FullName

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 FullName

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&BStr> for FullName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &BStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&BString> for FullName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &BString) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a FullName> for &'a PartialNameRef

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for FullName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<BString> for FullName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: BString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for FullName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FullName

impl StructuralEq for FullName

impl StructuralPartialEq for FullName