Struct SharedFilePicker 

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

Thread-safe shared handle to the FilePicker instance. This accumulates only asynchronous non-blocking operations against the file picker: creating, triggering various rescans and so on.

For blocking access use internal picker via .read() or .write()

let shared_picker = SharedFilePicker::default();

if let Some(picker) = shared_picker.read()?.as_ref() {
    let files = picker.fuzzy_search(&query, options);
    println!("Found {} files", files.len());
} else {
    println!("Picker not initialized");
}

Implementations

impl SharedFilePicker

pub fn read(&self) -> Result<RwLockReadGuard<'_, Option<FilePicker>>, Error>

pub fn write(&self) -> Result<RwLockWriteGuard<'_, Option<FilePicker>>, Error>

pub fn cancel(&self)

Signal the background scan to cancel. Non-blocking: post-scan threads check this flag and bail out at their next cancellation point.

pub fn need_complex_rebuild(&self) -> bool

Return true if this is an instance of the picker that requires a complicated post-scan indexing/cache warmup job. The indexing is not crazy but it takes time.

pub fn wait_for_scan(&self, timeout: Duration) -> bool

Block until the background filesystem scan finishes. Returns true if scan completed, false on timeout.

pub fn wait_for_watcher(&self, timeout: Duration) -> bool

Block until the background file watcher is ready. Returns true if watcher ready, false on timeout.

pub fn wait_for_indexing_complete(&self, timeout: Duration) -> bool

Blocks until both the filesystem walk and post-scan indexing are done. Returns true once scanning=false AND post_scan_indexing_active=false.

pub fn trigger_full_rescan_async( &self, shared_frecency: &SharedFrecency, ) -> Result<(), Error>

Trigger a full filesystem rescan without blocking the caller. Performs a safe async rescan. Guarantees only single active rescan per picker. If many rescans requested the last one guaranteed to be finished.

pub fn rescan_stats(&self) -> RescanStats

Returns admitted and throttled rescan requests by reason. Counters start at picker creation or the last reset.

pub fn reset_rescan_stats(&self)

pub fn watch( &self, pattern: &str, options: WatchOptions, callback: impl Fn(WatchId, &[WatchEvent]) + Send + Sync + 'static, ) -> Result<WatchId, Error>

Subscribe to filesystem changes matching pattern.

Patterns may be base-relative globs (./ works), exact paths inside the indexed tree, or existing directories. An empty pattern watches the whole tree.

Events are debounced and submitted in batches per 100-ms window at most 128 events. Gitignored and other ignored files are never triggering watcher.

pub fn unwatch(&self, id: WatchId) -> bool

Remove a watch subscription. Returns true if the id was active.

pub fn is_watch_active(&self, id: WatchId) -> bool

Return whether a watch subscription is active.

pub fn shutdown_watches(&self)

Remove every subscription without waiting for an executing callback.

pub fn shutdown_watches_and_wait(&self)

Remove every subscription and wait for an executing callback. When called by that callback, it does not wait on itself.

pub fn refresh_git_status( &self, shared_frecency: &SharedFrecency, ) -> Result<usize, Error>

Refresh git statuses for all indexed files

pub fn update_git_status_for_paths( &self, paths: &[PathBuf], shared_frecency: &SharedFrecency, ) -> Result<(), Error>

Recompute and apply git status for a specific set of paths.

Trait Implementations

impl Clone for SharedFilePicker

fn clone(&self) -> SharedFilePicker

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SharedFilePicker

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

Formats the value using the given formatter.

impl Default for SharedFilePicker

fn default() -> SharedFilePicker

Returns the “default value” for a type.