Struct GitRefName 

pub struct GitRefName { /* private fields */ }

A validated ref name.

Implementations

impl GitRefName

pub fn new(value: impl AsRef<str>) -> Result<Self, GitRefParseError>

Creates a ref name from text.

Errors

Returns GitRefParseError when the name is empty or uses rejected syntax.

pub const fn kind(&self) -> GitRefKind

Returns the broad ref kind.

pub const fn is_head(&self) -> bool

Returns true when this is HEAD.

pub const fn is_branch(&self) -> bool

Returns true when this is a branch ref.

pub const fn is_tag(&self) -> bool

Returns true when this is a tag ref.

pub const fn is_remote(&self) -> bool

Returns true when this is a remote-tracking ref.

pub fn as_str(&self) -> &str

Returns the ref name text.

Trait Implementations

impl AsRef<str> for GitRefName

fn as_ref(&self) -> &str

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

impl Clone for GitRefName

fn clone(&self) -> GitRefName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitRefName

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

Formats the value using the given formatter.

impl Display for GitRefName

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

Formats the value using the given formatter.

impl FromStr for GitRefName

type Err = GitRefParseError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for GitRefName

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 GitRefName

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

Restrict a value to a certain interval.

impl PartialEq for GitRefName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GitRefName

fn partial_cmp(&self, other: &GitRefName) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for GitRefName

type Error = GitRefParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for GitRefName

impl StructuralPartialEq for GitRefName