Struct RefName 

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

A pre-validated git reference name (branch/tag/remote), for callers that accept names from untrusted input (UIs, bots, agents) and want to fail early with a clear error. The dir-taking methods stay &str — they apply the same flag-injection guard internally — so this type is optional up-front validation, not a required wrapper.

Rules follow the load-bearing core of git check-ref-format: non-empty, no leading - or ., no .., no control characters or space, none of ~ ^ : ? * [ \, no trailing / or .lock.

Implementations

impl RefName

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

Validate name as a reference name.

pub fn as_str(&self) -> &str

The validated name.

Trait Implementations

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 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