Enum branchless::git::CategorizedReferenceName

pub enum CategorizedReferenceName<'a> {
    LocalBranch {
        name: &'a str,
        prefix: &'static str,
    },
    RemoteBranch {
        name: &'a str,
        prefix: &'static str,
    },
    OtherRef {
        name: &'a str,
    },
}

Determine what kind of branch a reference is, given its name. The returned suffix value is converted to a String to be rendered to the screen, so it may have lost some information if the reference name had unusual characters.

FIXME: This abstraction seems uncomfortable and clunky to use; consider revising.

Variants

LocalBranch

Fields

name: &'a str

The full name of the reference.

prefix: &'static str

The string refs/heads/.

The reference represents a local branch.

RemoteBranch

Fields

name: &'a str

The full name of the reference.

prefix: &'static str

The string refs/remotes/.

The reference represents a remote branch.

OtherRef

Fields

name: &'a str

The full name of the reference.

Some other kind of reference which isn’t a branch at all.

Implementations

impl<'a> CategorizedReferenceName<'a>

pub fn new(name: &'a ReferenceName) -> Self

Categorize the provided reference name.

pub fn remove_prefix(&self) -> Result<String>

Remove the prefix from the reference name. May raise an error if the result couldn’t be encoded as an String (shouldn’t happen).

pub fn render_full(&self) -> String

Render the full name of the reference, including its prefix, lossily as a String.

pub fn render_suffix(&self) -> String

Render only the suffix of the reference name lossily as a String. The caller will usually check the type of reference and add additional information to the reference name.

pub fn friendly_describe(&self) -> String

Render the reference name lossily, and prepend a helpful string like branch to the description.

Trait Implementations

impl<'a> Debug for CategorizedReferenceName<'a>

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

Formats the value using the given formatter.