Enum WorktreeError 

pub enum WorktreeError {
    NotInGitRepository {
        start: PathBuf,
    },
    BareRepositoryUnsupported {
        git_dir: PathBuf,
    },
    CannotDeterminePrimaryWorktree {
        git_common_dir: PathBuf,
    },
    NoParentDirectory {
        primary: PathBuf,
    },
    InvalidBranchName {
        given: String,
        reason: String,
    },
    PathEscape {
        branch: String,
        path: PathBuf,
        root: PathBuf,
    },
    ContainerNotADirectory {
        path: PathBuf,
    },
    WorktreeAlreadyExists {
        path: PathBuf,
        branch: String,
    },
    BranchAlreadyCheckedOut {
        branch: String,
        path: PathBuf,
        expected: PathBuf,
    },
    DestinationConflict {
        path: PathBuf,
        what: String,
    },
    BaseDoesNotExist {
        base: String,
    },
    Misplaced {
        path: PathBuf,
        branch: String,
        expected: PathBuf,
    },
    PrimaryOnNonTrunk {
        path: PathBuf,
        branch: String,
        trunk: String,
        expected: PathBuf,
    },
    DirtyWorktree {
        path: PathBuf,
        summary: String,
        operation: String,
    },
    LockedWorktree {
        path: PathBuf,
        reason: Option<String>,
    },
    PrimaryWorktreeProtected {
        path: PathBuf,
        operation: String,
    },
    NoSuchWorktree {
        selector: String,
    },
    NotThisRepository {
        path: PathBuf,
        git_common_dir: PathBuf,
    },
    MigrationUnsafe {
        path: PathBuf,
        reason: String,
    },
    VerificationFailed {
        path: PathBuf,
        differences: Vec<String>,
    },
    LockUnavailable {
        path: PathBuf,
        holder: Option<String>,
    },
    TopologyInvalid {
        count: usize,
    },
    GitCommandFailed {
        command: String,
        status: String,
        stderr: String,
    },
    GitUnavailable {
        reason: String,
    },
    Io {
        path: PathBuf,
        reason: String,
    },
}

Everything that stops a worktree operation.

Variants

NotInGitRepository

The start directory is not inside a git work tree.

Fields

start: PathBuf

Where the search began.

BareRepositoryUnsupported

The repository is bare. The topology is defined against a primary checkout.

Fields

git_dir: PathBuf

The bare repository directory.

CannotDeterminePrimaryWorktree

git worktree list answered, and nothing in it is the primary worktree.

Fields

git_common_dir: PathBuf

The common git directory the topology was read from.

NoParentDirectory

The primary checkout is at the filesystem root, so it has no parent to be a sibling in.

Fields

primary: PathBuf

The primary checkout.

InvalidBranchName

A branch name cannot be used as given.

Fields

given: String

What was given.

reason: String

Why it was refused.

PathEscape

The derived worktree path does not stay inside the container. Cannot happen for a valid branch name; refused by name rather than assumed away.

Fields

branch: String

The branch.

path: PathBuf

What was derived.

root: PathBuf

Where it had to be.

ContainerNotADirectory

The container path exists and is not a directory.

Fields

path: PathBuf

The container path.

WorktreeAlreadyExists

The worktree asked for is already registered at its canonical path.

Fields

path: PathBuf

The registered path.

branch: String

The branch it holds.

BranchAlreadyCheckedOut

The branch is checked out in a worktree that is not its canonical one.

Fields

branch: String

The branch.

path: PathBuf

Where it is checked out.

expected: PathBuf

Where it belongs.

DestinationConflict

The destination exists and is something else.

Fields

path: PathBuf

The occupied path.

what: String

What occupies it, in words.

BaseDoesNotExist

The base ref asked for does not resolve.

Fields

base: String

What was asked for.

Misplaced

The current worktree is not where its branch belongs.

Fields

path: PathBuf

The offending worktree.

branch: String

Its branch.

expected: PathBuf

Where the branch belongs.

PrimaryOnNonTrunk

The primary checkout holds a branch that is not the trunk.

Fields

path: PathBuf

The primary checkout.

branch: String

The branch it holds.

trunk: String

The trunk.

expected: PathBuf

Where the branch belongs.

DirtyWorktree

The worktree has uncommitted or untracked content and the operation would destroy it.

Fields

path: PathBuf

The worktree.

summary: String

What is dirty, in words.

operation: String

The operation that refused.

LockedWorktree

The worktree is locked; git refuses to move or remove it and so does this.

Fields

path: PathBuf

The worktree.

reason: Option<String>

The reason git recorded, when it recorded one.

PrimaryWorktreeProtected

The primary checkout was named to an operation that only linked worktrees accept.

Fields

path: PathBuf

The primary checkout.

operation: String

The operation that refused.

NoSuchWorktree

A selector matched nothing.

Fields

selector: String

What was asked for.

NotThisRepository

A path outside every worktree of this repository was named.

Fields

path: PathBuf

The path named.

git_common_dir: PathBuf

This repository’s common git directory.

MigrationUnsafe

A migration cannot be carried out safely, with the reason.

Fields

path: PathBuf

The worktree that would have moved.

reason: String

Why it was refused.

VerificationFailed

The fingerprint after a move differs from the one before it.

Fields

path: PathBuf

Where the worktree is now.

differences: Vec<String>

What differs, one line each.

LockUnavailable

The repository-scoped lock could not be taken.

Fields

path: PathBuf

The lock file.

holder: Option<String>

What the lock file says holds it, when it says.

TopologyInvalid

The topology is invalid: an error-level diagnostic stands.

Fields

count: usize

How many error-level diagnostics.

GitCommandFailed

A git command failed; its own words are carried through.

Fields

command: String

The arguments, joined for reading.

status: String

How it exited.

stderr: String

What it said on standard error.

GitUnavailable

git could not be run at all.

Fields

reason: String

Why not.

Io

A file or directory could not be read or written.

Fields

path: PathBuf

The path.

reason: String

What the operating system said.

Implementations

impl WorktreeError

pub fn exit_code(&self) -> u8

The exit code this error leaves the process with.

use majordomus_cli::worktree::WorktreeError;
use std::path::PathBuf;
let e = WorktreeError::NoSuchWorktree { selector: "nope".into() };
assert_eq!(e.exit_code(), 12);
let e = WorktreeError::DirtyWorktree {
    path: PathBuf::from("/a"), summary: "1 change".into(), operation: "remove".into(),
};
assert_eq!(e.exit_code(), 10);

pub fn code(&self) -> &'static str

The stable machine name of this refusal: what a script or a test matches on, so that neither has to match the prose. It is the variant’s own name.

use majordomus_cli::worktree::WorktreeError;
use std::path::PathBuf;
let e = WorktreeError::Misplaced {
    path: PathBuf::from("/tmp/x"), branch: "feature/x".into(), expected: PathBuf::from("/a/foo-wt/feature/x"),
};
assert_eq!(e.code(), "Misplaced");

pub fn io(path: impl Into<PathBuf>, e: &Error) -> Self

An IO failure against a path.

Trait Implementations

impl Clone for WorktreeError

fn clone(&self) -> WorktreeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeError

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

Formats the value using the given formatter.

impl Display for WorktreeError

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

Formats the value using the given formatter.

impl Eq for WorktreeError

impl Error for WorktreeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for WorktreeError

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