Struct WorktreeInfo 

pub struct WorktreeInfo {
    pub path: PathBuf,
    pub head: String,
    pub branch: Option<String>,
    pub bare: bool,
    pub detached: bool,
    pub locked: Option<String>,
    pub prunable: Option<String>,
}

Parsed worktree data from git worktree list --porcelain.

This is a data record containing metadata about a worktree. For running commands in a worktree, use WorkingTree via Repository::worktree_at() or BranchRef::working_tree().

Fields

path: PathBuf

head: String

branch: Option<String>

bare: bool

detached: bool

locked: Option<String>

prunable: Option<String>

Implementations

impl WorktreeInfo

pub fn is_prunable(&self) -> bool

Returns true if this worktree is prunable (directory deleted but git still tracks metadata).

Prunable worktrees cannot be operated on - the directory doesn’t exist. Most iteration over worktrees should skip prunable ones.

pub fn has_commits(&self) -> bool

Returns true if this worktree points to a real commit (not the null OID).

Unborn branches (no commits yet) have the null OID as their HEAD.

pub fn dir_name(&self) -> &str

Returns the worktree directory name.

This is the filesystem directory name (e.g., “repo.feature” from “/path/to/repo.feature”). For user-facing display with context (branch consistency, detached state), use worktree_display_name() from the commands module instead.

Trait Implementations

impl Clone for WorktreeInfo

fn clone(&self) -> WorktreeInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeInfo

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

Formats the value using the given formatter.

impl From<&WorktreeInfo> for BranchRef

fn from(wt: &WorktreeInfo) -> Self

Converts to this type from the input type.

impl PartialEq for WorktreeInfo

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorktreeInfo