Enum BranchInfo 

pub enum BranchInfo {
    Branch(String),
    DetachedHead(Option<String>),
    NotGitRepo,
}

Result of branch detection.

Variants

Branch(String)

On a named branch (e.g., “main”, “feature/foo”).

DetachedHead(Option<String>)

In detached HEAD state with optional commit hash.

NotGitRepo

Not in a git repository.

Implementations

impl BranchInfo

pub fn branch_name(&self) -> Option<&str>

Returns the branch name if on a named branch, None otherwise.

pub fn is_in_git_repo(&self) -> bool

Returns true if in a git repository (either on a branch or detached HEAD).

pub fn is_on_branch(&self) -> bool

Returns true if on a named branch.

pub fn is_detached(&self) -> bool

Returns true if in detached HEAD state.

Trait Implementations

impl Clone for BranchInfo

fn clone(&self) -> BranchInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchInfo

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

Formats the value using the given formatter.

impl PartialEq for BranchInfo

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

impl StructuralPartialEq for BranchInfo