Struct git_ref::FullNameRef

source · [−]

pub struct FullNameRef<'a>(_);

Expand description

A validated and potentially partial reference name - it can safely be used for common operations.

Implementations

source

impl<'a> FullNameRef<'a>

source

pub fn to_owned(&self) -> FullName

Create an owned copy of ourself

source

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.

source

impl<'a> FullNameRef<'a>

source

pub fn to_path(self) -> &'a Path

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

source

pub fn as_bstr(&self) -> &'a BStr

Return ourselves as byte string which is a valid refname

source

pub fn shorten(&self) -> &'a BStr

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

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

source

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

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

source

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

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

Trait Implementations

source

impl<'a> Clone for FullNameRef<'a>

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> Debug for FullNameRef<'a>

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Converts to this type from the input type.

source

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

source

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

Converts to this type from the input type.

source

impl<'a> Hash for FullNameRef<'a>

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<'a> Ord for FullNameRef<'a>

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl<'a> PartialEq<FullNameRef<'a>> for FullNameRef<'a>

source

fn eq(&self, other: &FullNameRef<'a>) -> bool

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

source

fn ne(&self, other: &FullNameRef<'a>) -> bool

This method tests for !=.

source

impl<'a> PartialOrd<FullNameRef<'a>> for FullNameRef<'a>

source

fn partial_cmp(&self, other: &FullNameRef<'a>) -> Option<Ordering>

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl<'a> TryFrom<FullNameRef<'a>> for PartialNameRef<'a>

type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl<'a> StructuralPartialEq for FullNameRef<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for FullNameRef<'a>

impl<'a> Send for FullNameRef<'a>

impl<'a> Sync for FullNameRef<'a>

impl<'a> Unpin for FullNameRef<'a>

impl<'a> UnwindSafe for FullNameRef<'a>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct git_ref::FullNameRef

Implementations

impl<'a> FullNameRef<'a>

pub fn to_owned(&self) -> FullName

pub fn file_name(&self) -> &BStr

impl<'a> FullNameRef<'a>

pub fn to_path(self) -> &'a Path

pub fn as_bstr(&self) -> &'a BStr

pub fn shorten(&self) -> &'a BStr

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

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

Trait Implementations

impl<'a> Clone for FullNameRef<'a>

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

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

impl<'a> Debug for FullNameRef<'a>

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

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

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

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

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

impl<'a> Hash for FullNameRef<'a>

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

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

impl<'a> Ord for FullNameRef<'a>

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

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

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

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

impl<'a> PartialEq<FullNameRef<'a>> for FullNameRef<'a>

fn eq(&self, other: &FullNameRef<'a>) -> bool

fn ne(&self, other: &FullNameRef<'a>) -> bool

impl<'a> PartialOrd<FullNameRef<'a>> for FullNameRef<'a>

fn partial_cmp(&self, other: &FullNameRef<'a>) -> Option<Ordering>

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

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

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

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

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

type Error = Error

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

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

type Error = Error

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

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

type Error = Error

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

impl<'a> TryFrom<FullNameRef<'a>> for PartialNameRef<'a>

type Error = Infallible

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

impl<'a> Copy for FullNameRef<'a>

impl<'a> Eq for FullNameRef<'a>

impl<'a> StructuralEq for FullNameRef<'a>

impl<'a> StructuralPartialEq for FullNameRef<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for FullNameRef<'a>

impl<'a> Send for FullNameRef<'a>

impl<'a> Sync for FullNameRef<'a>

impl<'a> Unpin for FullNameRef<'a>

impl<'a> UnwindSafe for FullNameRef<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,