ratatui-toolkit 0.2.6

DEPRECATED: this crate was renamed to `ratkit`. Please migrate to `ratkit`.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//! Convenience constructor for directory watching.

use crate::services::file_watcher::{FileWatcher, WatchConfig, WatchMode};

impl FileWatcher {
    /// Create a file watcher preset for watching a directory recursively.
    ///
    /// Uses `WatchMode::Recursive` with 200ms debounce (longer to handle
    /// rapid changes during builds or git operations).
    ///
    /// # Errors
    ///
    /// Returns a `notify::Error` if the watcher cannot be created.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use ratatui_toolkit::services::file_watcher::FileWatcher;
    /// use std::path::Path;
    ///
    /// let mut watcher = FileWatcher::for_directory().unwrap();
    /// watcher.watch(Path::new("./src")).unwrap();
    /// ```
    pub fn for_directory() -> Result<Self, notify::Error> {
        Self::with_config(WatchConfig {
            mode: WatchMode::Recursive,
            debounce_ms: 200,
        })
    }
}