Struct git_ref::FullName

source · [−]

pub struct FullName(_);

Expand description

Indicate that the given BString is a validate reference name or path that can be used as path on disk or written as target of a symbolic reference

Implementations

source

impl FullName

source

pub fn to_partial(&self) -> PartialNameRef<'_>

Interpret this fully qualified reference name as partial name.

source

pub fn to_ref(&self) -> FullNameRef<'_>

Interpret this fully qualified reference as shared full name

source

pub fn to_path(&self) -> &Path

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

source

pub fn into_inner(self) -> BString

Dissolve this instance and return the buffer.

source

pub fn as_bstr(&self) -> &BStr

Return ourselves as byte string which is a valid refname

source

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

source

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.

source

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.

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, &BStr)>

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

Trait Implementations

source

impl Clone for FullName

source

fn clone(&self) -> FullName

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

source

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

Formats the value using the given formatter. Read more

source

impl Display for FullName

source

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

Formats the value using the given formatter. Read more

source

impl From<FullName> for BString

source

fn from(name: FullName) -> Self

Converts to this type from the input type.

source

impl From<FullName> for Target

source

fn from(name: FullName) -> 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 Hash for FullName

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

source

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

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<FullName> for FullName

source

fn partial_cmp(&self, other: &FullName) -> 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 TryFrom<&'_ BStr> for FullName

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<&'_ str> for FullName

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<BString> for FullName

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<String> for FullName

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl Eq for FullName

source

impl StructuralEq for FullName

source

impl StructuralPartialEq for FullName

Auto Trait Implementations

impl RefUnwindSafe for FullName

impl Send for FullName

impl Sync for FullName

impl Unpin for FullName

impl UnwindSafe for FullName

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> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. 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::FullName

Implementations

impl FullName

pub fn to_partial(&self) -> PartialNameRef<'_>

pub fn to_ref(&self) -> FullNameRef<'_>

pub fn to_path(&self) -> &Path

pub fn into_inner(self) -> BString

pub fn as_bstr(&self) -> &BStr

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

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

pub fn shorten(&self) -> &BStr

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

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

Trait Implementations

impl Clone for FullName

fn clone(&self) -> FullName

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

impl Debug for FullName

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

impl Display for FullName

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

impl From<FullName> for BString

fn from(name: FullName) -> Self

impl From<FullName> for Target

fn from(name: FullName) -> Self

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

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

impl Hash for FullName

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

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

impl Ord for FullName

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

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

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

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

impl PartialEq<FullName> for FullName

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

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

impl PartialOrd<FullName> for FullName

fn partial_cmp(&self, other: &FullName) -> 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 TryFrom<&'_ BStr> for FullName

type Error = Error

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

impl TryFrom<&'_ str> for FullName

type Error = Error

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

impl TryFrom<BString> for FullName

type Error = Error

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

impl TryFrom<String> for FullName

type Error = Error

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

impl Eq for FullName

impl StructuralEq for FullName

impl StructuralPartialEq for FullName

Auto Trait Implementations

impl RefUnwindSafe for FullName

impl Send for FullName

impl Sync for FullName

impl Unpin for FullName

impl UnwindSafe for FullName

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)

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> ToString for T where
T: Display + ?Sized,

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

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