Enum Error 

pub enum Error {
    NotInRepo,
    NoCurrentWorktree,
    Ambiguous {
        query: String,
        candidates: Vec<String>,
    },
    NotFound {
        query: String,
    },
    NothingSelected,
    Usage(String),
    Config {
        file: String,
        key: String,
        reason: String,
    },
    Subprocess {
        program: String,
        stderr: String,
    },
    GhUnavailable(String),
    AgentUnavailable(String),
    Operation(String),
    Io(Error),
    Json(Error),
}

Errors produced by wt library operations.

Variants

NotInRepo

The current directory is not inside a Git repository.

NoCurrentWorktree

There is no current worktree (e.g. a bare repository) but the command requires one.

Ambiguous

A query resolved to more than one worktree (spec exit code 3).

Fields

query: String

The query string that was ambiguous.

candidates: Vec<String>

Human-readable identifiers of the matching worktrees.

NotFound

A query matched no worktree (spec exit code 1).

Fields

query: String

The query string that matched nothing.

NothingSelected

Nothing was selected, e.g. a cancelled picker (spec exit code 3).

Usage(String)

A usage or argument error (spec exit code 2).

Config

A configuration error, naming the file, key, and reason.

Fields

file: String

Path (or label) of the offending config file.

key: String

The offending key.

reason: String

Why it was rejected.

Subprocess

A subprocess (git, gh, or a code agent) failed; stderr is surfaced verbatim.

Fields

program: String

The program that failed (e.g. git, gh, claude).

stderr: String

Captured standard error, verbatim.

GhUnavailable(String)

The gh CLI is missing or unauthenticated.

AgentUnavailable(String)

No code-agent CLI is available (missing binary or failed to launch).

Operation(String)

An operation failed for the reason described by the message.

Io(Error)

An underlying I/O error.

Json(Error)

A JSON serialization or deserialization error.

Implementations

impl Error

pub fn exit_code(&self) -> u8

The process exit code this error maps to (spec §12): 2 for usage errors, 3 for ambiguous queries or nothing selected, 1 otherwise.

pub fn operation(message: impl Into<String>) -> Self

Builds an Error::Operation from anything string-like.

pub fn usage(message: impl Into<String>) -> Self

Builds an Error::Usage from anything string-like.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.