Enum gix::remote::Name

pub enum Name<'repo> {
    Symbol(Cow<'repo, str>),
    Url(Cow<'repo, BStr>),
}

The name of a remote, either interpreted as symbol like origin or as url as returned by Remote::name().

Variants

Symbol(Cow<'repo, str>)

A symbolic name, like origin. Note that it has not necessarily been validated yet.

Url(Cow<'repo, BStr>)

A url pointing to the remote host directly.

Implementations

impl Name<'_>

pub fn as_bstr(&self) -> &BStr

Obtain the name as string representation.

pub fn as_symbol(&self) -> Option<&str>

Return this instance as a symbolic name, if it is one.

pub fn as_url(&self) -> Option<&BStr>

Return this instance as url, if it is one.

Trait Implementations

impl<'a> AsRef<BStr> for Name<'a>

fn as_ref(&self) -> &BStr

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

impl<'repo> Clone for Name<'repo>

fn clone(&self) -> Name<'repo>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'repo> Debug for Name<'repo>

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

Formats the value using the given formatter.

impl From<BString> for Name<'static>

fn from(name: BString) -> Self

Converts to this type from the input type.

impl<'repo> Hash for Name<'repo>

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<'repo> Ord for Name<'repo>

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

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

fn partial_cmp(&self, other: &Name<'repo>) -> 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<'a> TryFrom<Cow<'a, BStr>> for Name<'a>

type Error = Cow<'a, BStr>

The type returned in the event of a conversion error.

fn try_from(name: Cow<'a, BStr>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'repo> Eq for Name<'repo>

impl<'repo> StructuralEq for Name<'repo>

impl<'repo> StructuralPartialEq for Name<'repo>