Struct Worktree 

pub struct Worktree {
    pub path: PathBuf,
    pub head: Option<String>,
    pub branch: Option<String>,
    pub is_main: bool,
    pub is_detached: bool,
    pub is_bare: bool,
    pub is_locked: bool,
    pub lock_reason: Option<String>,
    pub is_prunable: bool,
    pub prune_reason: Option<String>,
}

One git worktree as reported by git worktree list --porcelain.

Fields

path: PathBuf

Absolute path to the worktree directory.

head: Option<String>

Commit SHA at HEAD. None for bare worktrees.

branch: Option<String>

Branch name without refs/heads/ prefix. None when the worktree has detached HEAD (or is bare).

is_main: bool

True for the primary worktree (the one git considers the “main” worktree). Always the first in the list returned by WorktreeRoot::list.

is_detached: bool

True if HEAD is detached (no branch checked out).

is_bare: bool

True for a bare repository worktree.

is_locked: bool

True if git worktree lock has been applied.

lock_reason: Option<String>

Optional human-readable lock reason if is_locked.

is_prunable: bool

True if git considers this worktree prunable (the directory is missing or the lock file is stale).

prune_reason: Option<String>

Optional human-readable prunable reason if is_prunable.

Trait Implementations

impl Clone for Worktree

fn clone(&self) -> Worktree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Worktree

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

Formats the value using the given formatter.

impl Serialize for Worktree

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

where __S: Serializer,

Serialize this value into the given Serde serializer.