Struct RepoWatcher 

pub struct RepoWatcher { /* private fields */ }

A live watch over a repository, yielding RepoChanges as the repo’s state changes. Dropping it stops the filesystem watch and the background task.

Implementations

impl RepoWatcher

pub fn builder(repo: impl VcsRepo + 'static) -> Builder

A builder over repo (any VcsRepo — e.g. a vcs_core::Repo).

pub async fn watch(repo: impl VcsRepo + 'static) -> Result<RepoWatcher>

Start watching repo with the defaults (state dir only, 250 ms debounce).

pub async fn recv(&mut self) -> Option<RepoChange>

Await the next settled change. Returns None once the watcher is dropped or its background task ends.

pub fn current(&self) -> &RepoSnapshot

The most recent known snapshot — the baseline captured at build, then the snapshot from each recv. It advances only when you call recv, so it is as fresh as your last recv, not a live view.

pub fn stats(&self) -> WatcherStats

The watcher’s health counters (re-queries run / changes emitted / skips, what the last skip failed on, and OS-watch errors). Cheap relaxed-atomic reads — poll it from a health check or log it periodically; a climbing skipped with flat changes means the repository is wedged, and a non-zero watch_errors means the OS watch is failing (e.g. the watched dir was re-created) — rebuild the watcher.

Trait Implementations

impl Drop for RepoWatcher

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Stream for RepoWatcher

Available on crate feature stream only.

Yields each settled RepoChange as a stream item (the stream feature). Equivalent to looping recv — both pull from the same underlying channel (an item is delivered to whichever is polled first, never duplicated) and both advance current.

type Item = RepoChange

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<RepoChange>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.