Struct Worktree 

pub struct Worktree {

    pub schema_version: u32,
    pub path: PathBuf,
    pub branch: Option<String>,
    pub slug: Option<String>,
    pub is_current: bool,
    pub is_main: bool,
    pub is_missing: bool,
    pub is_detached: bool,
    pub dirty: Option<bool>,
    pub has_untracked: Option<bool>,
    pub ahead: Option<u32>,
    pub behind: Option<u32>,
    pub upstream: Option<String>,
    pub base_ref: Option<String>,
    pub commit: Option<Commit>,
    pub pr: Option<Pr>,
    pub has_worktree: bool,
    pub recent_commits: Vec<Commit>,
    pub pr_url: Option<String>,
    pub merge_state: Option<MergeState>,
}

One worktree row — the stable §7 JSON schema shared by list, status, and the new/pr/remove result objects.

Fields

schema_version: u32

Schema version (always SCHEMA_VERSION).

path: PathBuf

Absolute path of the worktree.

branch: Option<String>

Full branch name, or None for a detached HEAD.

slug: Option<String>

Filesystem-safe slug of the branch, or None when detached.

is_current: bool

Whether this is the current worktree.

is_main: bool

Whether this is the primary worktree.

is_missing: bool

Whether the worktree’s directory has been deleted externally.

is_detached: bool

Whether the worktree has a detached HEAD.

dirty: Option<bool>

Whether tracked files are modified/staged; None when missing.

has_untracked: Option<bool>

Whether untracked files are present; None when missing.

ahead: Option<u32>

Commits ahead of upstream; None when no upstream or missing.

behind: Option<u32>

Commits behind upstream; None when no upstream or missing.

upstream: Option<String>

Upstream tracking branch (e.g. origin/feature/login); None if unset.

base_ref: Option<String>

Base ref recorded at creation; None if unset.

commit: Option<Commit>

Tip commit metadata; None when missing.

pr: Option<Pr>

Recorded pull request; None when none.

has_worktree: bool

Whether a checked-out worktree exists for this row. false marks a “branch row”: a local branch with no worktree, listed beneath the real worktrees with its ahead/behind relative to its base (issue #47). Not part of the §7 JSON schema (where every row is a real worktree), so it is skipped during serialization. Branch rows are normally TUI-only, but wt sync <branch> of a worktree-less branch emits one in --json; such a row’s path is the branch://<branch> sentinel rather than a filesystem path, since no checkout exists.

recent_commits: Vec<Commit>

Up to the last five commits, for the TUI detail pane only. Not part of the §7 JSON schema (which carries only the tip commit), so it is skipped during serialization.

pr_url: Option<String>

The recorded PR URL, for the TUI detail pane only. Not part of the §7 pr object, so it is skipped during serialization.

merge_state: Option<MergeState>

Offline merge/tracking state, for delete-safety messaging in the TUI only. None until enrichment runs (and for a missing worktree, where it cannot be computed). Not part of the §7 JSON schema, so it is skipped during serialization.

Implementations

impl Worktree

pub fn new(path: PathBuf) -> Self

Builds a worktree row with the given absolute path and all other fields at their defaults (no branch, all flags false, all optionals None, and has_worktree true — a real checkout). Callers populate the remaining fields.

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

Serializes this row to a single-line JSON string (no trailing newline), for the newline-delimited --json framing of list/status.

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

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 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.

impl StructuralPartialEq for Worktree