Struct WatchError 

pub struct WatchError(/* private fields */);

An opaque filesystem-watch backend failure — the watcher couldn’t start, or couldn’t register/deregister a watched path.

It wraps the crate’s private watch backend so a consumer can classify and source-chain the failure without naming — or depending on — that third-party crate:

• is_path_not_found — the watched .git/.jj directory does not exist (removed, or never present);
• is_watch_limit — the OS watch-descriptor limit was reached (e.g. Linux inotify’s max_user_watches);
• io_error — the raw std::io::Error when the backend failure was an I/O one (also reachable via std::error::Error::source);
• paths — the paths the backend blamed, if any.

Because the backend type never appears in a public signature, a backend major bump is an internal change here — not a breaking one downstream. Obtain one from Error::watch_error or by matching Error::Notify.

Implementations

impl WatchError

pub fn is_path_not_found(&self) -> bool

The watched path does not exist — e.g. the .git/.jj state directory was removed (or never existed), so the OS watch can’t be registered until the path is present.

pub fn is_watch_limit(&self) -> bool

The OS watch-descriptor limit was reached (e.g. Linux inotify’s max_user_watches) — the watch can’t be registered until the limit is raised or other watches are released. Best-effort / platform-dependent.

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

The underlying std::io::Error when the backend failure was an I/O error (None otherwise) — inspect its kind without walking the source chain.

pub fn paths(&self) -> &[PathBuf]

The paths the backend associated with this failure — empty for a general, path-less failure.

Trait Implementations

impl Debug for WatchError

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

Formats the value using the given formatter.

impl Display for WatchError

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

Formats the value using the given formatter.

impl Error for WatchError

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.