Struct WorktreeRemove 

#[non_exhaustive]
pub struct WorktreeRemove {
    pub path: PathBuf,
    pub force: bool,
}

Options for Repo::remove_worktree.

#[non_exhaustive], so build it through WorktreeRemove::new and the chained force setter rather than a struct literal — a bare bool at the call site (remove_worktree(path, true)) doesn’t say what true means, and this leaves room to add options without a breaking signature change.

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

The attached worktree (git) / secondary workspace (jj) path to remove.

force: bool

Remove even when the worktree has uncommitted changes — git worktree remove --force; on jj, the snapshot-and-refuse-if-dirty guard is bypassed. The repository’s main worktree/workspace is refused regardless of this flag.

Implementations

impl WorktreeRemove

pub fn new(path: impl Into<PathBuf>) -> Self

Remove the worktree/workspace at path; not forced (refuses a dirty one).

pub fn force(self) -> Self

Remove even when the worktree has uncommitted changes.

Trait Implementations

impl Clone for WorktreeRemove

fn clone(&self) -> WorktreeRemove

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeRemove

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

Formats the value using the given formatter.

impl Eq for WorktreeRemove

impl PartialEq for WorktreeRemove

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