Enum Error 

#[non_exhaustive]
pub enum Error {
    Notify(WatchError),
    Vcs(Error),
    Io(Error),
}

An error from setting up or running a RepoWatcher.

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.

Notify(WatchError)

The filesystem watcher failed to start, or to register/deregister a watched path. Opaque over the private backend — inspect it through WatchError’s classifiers (reachable directly, or via Error::watch_error) instead of the backend’s own error type.

Vcs(Error)

A vcs-core query (detection / snapshot / local_branches) failed — chiefly while building the watcher (capturing the baseline state). A re-query failure during watching is skipped and retried, not surfaced here (see RepoWatcher).

Io(Error)

A filesystem operation failed (e.g. resolving a worktree gitlink).

Implementations

impl Error

pub fn is_transient(&self) -> bool

Whether this wraps a transient failure worth retrying — an interrupted / would-block / resource-busy io/spawn failure from the underlying vcs-core query (delegates to vcs_core::Error::is_transient), or a baseline-snapshot timeout (Io TimedOut, raised when the startup snapshot exceeds requery_timeout) — a wedged repo may un-wedge, and the loop already treats a re-query timeout as a transient skip, so build() agrees. Other Io and Notify errors are false (a failed OS watch registration won’t fix itself on a blind retry — classify it via WatchError and act on the cause). Mirrors the classifier family on the other facades.

pub fn is_not_found(&self) -> bool

Whether the underlying VCS binary (git/jj) wasn’t found — a setup problem (not installed / not on PATH), surfaced while building the watcher’s baseline. Delegates to vcs_core::Error::is_not_found.

pub fn watch_error(&self) -> Option<&WatchError>

The opaque WatchError when this is a filesystem-watch backend failure; None for a Vcs/Io error. A stable accessor (mirroring processkit_error) so a caller — or a language binding — can reach the watch classifiers without matching the enum variant by hand.

pub fn processkit_error(&self) -> Option<&Error>

The structured underlying processkit::Error, if this error came from a VCS subprocess — flattening the two-level Vcs(vcs_core::Error::Vcs(_)) nesting so a caller (or a language binding) can read its structured fields (program, plus code/stdout/ stderr on an Exit) without hand-walking it. None for a Notify/Io failure or a non-subprocess vcs-core error (e.g. “not a repository”).

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, f: &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(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.