Struct Worktree 

#[non_exhaustive]
pub struct Worktree {
    pub path: PathBuf,
    pub branch: Option<String>,
    pub head: Option<String>,
    pub bare: bool,
    pub detached: bool,
    pub locked: bool,
}

A worktree from git worktree list --porcelain.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: PathBuf

Absolute path to the worktree.

branch: Option<String>

Short branch name (refs/heads/ stripped); None when detached or bare.

head: Option<String>

The checked-out commit (HEAD <sha>); None for a bare entry.

bare: bool

The main worktree of a bare repository.

detached: bool

Checked out at a detached HEAD (no branch).

locked: bool

Locked against pruning.

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 PartialEq for Worktree

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

impl StructuralPartialEq for Worktree