Struct RefName 

pub struct RefName(/* private fields */);

Validated git ref name — guaranteed to satisfy gix_validate::reference::name (the strict, fully-qualified form).

Implementations

impl RefName

pub fn new(name: impl Into<String>) -> Result<Self, RefNameError>

Validate name and wrap it.

Errors

Returns RefNameError::Invalid for any name that gix-validate would reject.

pub fn as_str(&self) -> &str

Borrow as a plain &str.

pub fn is_valid(name: &str) -> bool

true iff name would be accepted by RefName::new. A borrow-only predicate for callers that just need the validity check without keeping the wrapped value — avoids the String allocation new performs on its impl Into<String> argument.

Trait Implementations

impl AsRef<str> for RefName

fn as_ref(&self) -> &str

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

impl Clone for RefName

fn clone(&self) -> RefName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefName

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

Formats the value using the given formatter.

impl Display for RefName

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

Formats the value using the given formatter.

impl Eq for RefName

impl From<RefName> for String

fn from(value: RefName) -> Self

Converts to this type from the input type.

impl Hash for RefName

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 PartialEq for RefName

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