Enum WorktreeError 

#[non_exhaustive]
pub enum WorktreeError {
    BareRepository,
    NotRegistered {
        path: PathBuf,
    },
    MainWorktree {
        operation: WorktreeOperation,
    },
    Locked {
        reason: Option<String>,
    },
    AlreadyLocked {
        reason: Option<String>,
    },
    NotLocked,
    HasLocalChanges,
    HasSubmodules,
    PathRegistered {
        path: PathBuf,
    },
    PathRegisteredMissing {
        path: PathBuf,
    },
    PathExists {
        path: PathBuf,
    },
    PathExistsNotDirectory {
        path: PathBuf,
    },
    NotADirectory {
        path: PathBuf,
    },
    PathNotFound {
        path: PathBuf,
    },
    NoFileName {
        path: PathBuf,
    },
    InvalidAdminDir {
        path: PathBuf,
    },
    BranchTipMismatch {
        branch: String,
    },
    DotGitIsDirectory {
        path: PathBuf,
    },
    BrokenGitFile {
        path: PathBuf,
    },
    LockHeld {
        path: PathBuf,
    },
    NonUtf8SubmodulePath {
        path: Vec<u8>,
    },
}

Linked worktree failures, wrapped by Error::Worktree.

Branch problems met while adding a worktree (invalid, missing or existing branch names) are reported as BranchError instead, and a branch held by another worktree as Error::BranchCheckedOutInWorktree.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BareRepository

Linked worktrees cannot be added to a bare repository.

NotRegistered

No registered worktree has path as its working tree root.

Fields

path: PathBuf

Normalized path that matched no registry entry.

MainWorktree

The operation only applies to linked worktrees.

Fields

operation: WorktreeOperation

Operation that was refused.

Locked

The worktree is locked and the caller did not force the operation.

Fields

reason: Option<String>

Contents of the locked file, when non-empty.

AlreadyLocked

Lock was requested for a worktree that is already locked.

Fields

reason: Option<String>

Contents of the existing locked file, when non-empty.

NotLocked

Unlock was requested for a worktree that is not locked.

HasLocalChanges

Remove without force found staged, unstaged, conflicted or untracked changes.

HasSubmodules

Move found populated submodules inside the worktree.

PathRegistered

The path is registered to a worktree whose directory still exists.

Fields

path: PathBuf

Registered working tree path.

PathRegisteredMissing

The path is registered to a worktree whose directory is missing, and add was not forced.

Fields

path: PathBuf

Registered working tree path that is missing on disk.

PathExists

The target directory exists and is not empty (add) or exists at all (move).

Fields

path: PathBuf

Occupied path.

PathExistsNotDirectory

The add target exists and is a file or other non-directory.

Fields

path: PathBuf

Occupied path.

NotADirectory

A path that must be a directory (repair target, move destination parent) is not one.

Fields

path: PathBuf

Offending path.

PathNotFound

A repair target does not exist.

Fields

path: PathBuf

Missing path.

NoFileName

The path has no final component to name the worktree after (for example /).

Fields

path: PathBuf

Path without a final component.

InvalidAdminDir

A worktree admin directory has no parent directory.

Fields

path: PathBuf

Admin directory path.

BranchTipMismatch

An existing branch used for the worktree HEAD does not point at the start commit.

Fields

branch: String

Short branch name.

DotGitIsDirectory

Repair expected a .git gitfile but found a directory.

Fields

path: PathBuf

The worktree’s .git path.

BrokenGitFile

Repair could not map a worktree’s .git gitfile to a registered admin directory.

Fields

path: PathBuf

The worktree’s .git path.

LockHeld

Another process holds the lock file guarding a worktree link file.

Fields

path: PathBuf

Lock file path.

NonUtf8SubmodulePath

A gitlink entry in the worktree index has a path that is not valid UTF-8.

Fields

path: Vec<u8>

Raw index path bytes.

Trait Implementations

impl Clone for WorktreeError

fn clone(&self) -> Self

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 From<WorktreeError> for Error

fn from(source: WorktreeError) -> Self

Converts to this type from the input type.

impl PartialEq for WorktreeError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WorktreeError