Struct DatabaseWatcher 

pub struct DatabaseWatcher<'a> { /* private fields */ }

Database watcher service that monitors file changes and updates the database.

Implementations

impl<'a> DatabaseWatcher<'a>

pub fn new(database: Database<'a>) -> Self

pub fn watch(&mut self, options: WatchOptions) -> Result<(), DatabaseError>

pub fn stop(&mut self)

Stops watching if currently active.

pub fn is_watching(&self) -> bool

Checks if the watcher is currently active.

pub fn wait(&mut self) -> Result<Vec<FileId>, DatabaseError>

Waits for file changes and updates the database.

This method blocks until file changes are detected, then updates the database in place and returns the IDs of changed files.

Returns

• Ok(file_ids) - The IDs of files that were changed (empty if no changes)
• Err(DatabaseError::WatcherNotActive) - If the watcher is not currently watching
• Err(e) - If updating the database failed

pub fn database(&self) -> &Database<'a>

Returns a reference to the database.

pub fn read_only_database(&self) -> ReadDatabase

Returns a reference to the database.

pub fn database_mut(&mut self) -> &mut Database<'a>

Returns a mutable reference to the database.

pub fn with_database_mut<F, R>(&mut self, f: F) -> R

where F: for<'x> FnOnce(&'x mut Database<'a>) -> R,

Provides temporary mutable access to the database through a closure.

This method helps Rust’s borrow checker understand that the mutable borrow of the database is scoped to just the closure execution, allowing the watcher to be used again after the closure returns.

The closure is bounded with for<’x> to explicitly show that the database reference lifetime is scoped to the closure execution only.

pub fn into_database(self) -> Database<'a>

Consumes the watcher and returns the database.

Trait Implementations

impl<'a> Drop for DatabaseWatcher<'a>

fn drop(&mut self)

Executes the destructor for this type.