Struct RefName 

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

A validated git reference name (branch/tag/remote-tracking ref). Every GitApi operation that names a branch, tag, or ref to create, delete, rename, or look up by exact name takes a RefName (directly or inside its options struct), so a name from untrusted input (UIs, bots, agents) is validated once, at construction, and the type — not an internal guard — is the argv-injection barrier from then on. For a general commit-ish or range (checkout, reset_hard, log, diff ranges, …) use the more permissive RevSpec instead.

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. A rejected name is an vcs_cli_support::is_invalid_input failure.

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

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this 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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RefName