Struct git_ref::PartialNameRef

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

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

Implementations

impl PartialNameRef

pub fn to_partial_path(&self) -> &Path

Convert this name into the relative path possibly identifying the reference location. Note that it may be only a partial path though.

Examples found in repository

src/store/file/find.rs (line 300)

        pub(crate) fn find_existing_inner<'a, Name, E>(
            &self,
            partial: Name,
            packed: Option<&packed::Buffer>,
        ) -> Result<Reference, Error>
        where
            Name: TryInto<&'a PartialNameRef, Error = E>,
            crate::name::Error: From<E>,
        {
            let path = partial
                .try_into()
                .map_err(|err| Error::Find(find::Error::RefnameValidation(err.into())))?;
            match self.find_one_with_verified_input(path, packed) {
                Ok(Some(r)) => Ok(r),
                Ok(None) => Err(Error::NotFound {
                    name: path.to_partial_path().to_owned(),
                }),
                Err(err) => Err(err.into()),
            }
        }

pub fn as_bstr(&self) -> &BStr

Provide the name as binary string which is known to be a valid partial ref name.

Examples found in repository

src/store/packed/find.rs (line 22)

    pub fn try_find<'a, Name, E>(&self, name: Name) -> Result<Option<packed::Reference<'_>>, Error>
    where
        Name: TryInto<&'a PartialNameRef, Error = E>,
        Error: From<E>,
    {
        let name = name.try_into()?;
        let mut buf = BString::default();
        for inbetween in &["", "tags", "heads", "remotes"] {
            let (name, was_absolute) = if name.looks_like_full_name() {
                let name = FullNameRef::new_unchecked(name.as_bstr());
                let name = match transform_full_name_for_lookup(name) {
                    None => return Ok(None),
                    Some(name) => name,
                };
                (name, true)
            } else {
                let full_name = name.construct_full_name_ref(true, inbetween, &mut buf);
                (full_name, false)
            };
            match self.try_find_full_name(name)? {
                Some(r) => return Ok(Some(r)),
                None if was_absolute => return Ok(None),
                None => continue,
            }
        }
        Ok(None)
    }

Trait Implementations

impl AsRef<PartialNameRef> for PartialName

fn as_ref(&self) -> &PartialNameRef

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

impl Borrow<PartialNameRef> for PartialName

fn borrow(&self) -> &PartialNameRef

Immutably borrows from an owned value.

impl Debug for PartialNameRef

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl Hash for PartialNameRef

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

Feeds this value into the given Hasher.

impl Ord for PartialNameRef

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

This method returns an Ordering between self and other.

impl PartialEq<PartialNameRef> for PartialNameRef

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

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

type Owned = PartialName

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 PartialNameRef

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 BString> for &'a PartialNameRef

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a 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<'a> TryFrom<&'a OsStr> for &'a PartialNameRef

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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 PartialNameRef

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 PartialNameRef

impl StructuralEq for PartialNameRef

impl StructuralPartialEq for PartialNameRef