Enum WorktreeError 

#[non_exhaustive]
pub enum WorktreeError {
    NotAGitRepo,
    GitCommand {
        op: String,
        stderr: String,
    },
    PathExists(PathBuf),
    BaseRefUnresolved {
        attempted: String,
    },
    InvalidBranchName(String),
    RootOutsideRepo(PathBuf),
    Io(Error),
}

All errors that zeph-worktree can produce.

Every variant is designed so that the Display message is safe to show to the user; raw git stderr is kept in WorktreeError::GitCommand’s stderr field and must only be logged at DEBUG level — never forwarded to the user.

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.

NotAGitRepo

The working directory is not inside a git repository.

GitCommand

A git sub-command exited with a non-zero status.

op names the operation (e.g. "fetch", "worktree add"). stderr is raw git output — log at DEBUG, never surface to the user.

Fields

op: String

The git operation that failed (e.g. "fetch", "worktree add").

stderr: String

Raw stderr from git — for diagnostic logging only.

PathExists(PathBuf)

The computed worktree path already exists on disk.

BaseRefUnresolved

The default branch could not be resolved.

Emitted when config.default_branch is empty and git symbolic-ref refs/remotes/origin/HEAD fails.

Fields

attempted: String

Description of what was attempted before giving up.

InvalidBranchName(String)

The subagent_id value contains characters that are not allowed in a git branch component.

RootOutsideRepo(PathBuf)

The canonicalised worktree root resolves to a path outside the repository.

Io(Error)

An I/O error propagated from the OS or std::fs.

Trait Implementations

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

fn from(source: Error) -> Self

Converts to this type from the input type.