Struct DiskWatcherConfig 

pub struct DiskWatcherConfig {
    pub recursive_mode: Option<DiskWatcherRecursiveMode>,
    pub poll_interval: Option<Duration>,
    pub report_invalidation_reason: bool,
}

Fields

recursive_mode: Option<DiskWatcherRecursiveMode>

Whether to let the [notify::Watcher] recurse into subdirectories itself, or to track and watch each directory we care about ourselves.

None picks a default based on the platform and Self::poll_interval, which is normally what you want.

The TURBO_TASKS_FORCE_WATCH_MODE environment variable will override this configuration value (intended for debugging purposes).

poll_interval: Option<Duration>

Poll the filesystem at this interval instead of using the platform’s native file watching, for cases where native watching doesn’t work (e.g. some Docker setups). This is slow and inefficient, it should only be used as a last resort.

None disables polling, using the platform’s native watcher ([RecommendedWatcher]) instead of [PollWatcher].

report_invalidation_reason: bool

Attach an [InvalidationReason] to every invalidation the watcher causes ([WatchStart], [WatchChange], or [InvalidateRescan]), so that it can be reported to the user.

This costs an extra allocation per invalidated path, so it’s only worth enabling when something actually consumes the reasons.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for DiskWatcherConfig

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for DiskWatcherConfig

fn clone(&self) -> DiskWatcherConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DiskWatcherConfig

impl Debug for DiskWatcherConfig

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for DiskWatcherConfig

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for DiskWatcherConfig

fn default() -> DiskWatcherConfig

Returns the “default value” for a type.

impl Encode for DiskWatcherConfig

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Eq for DiskWatcherConfig

impl Hash for DiskWatcherConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NonLocalValue for DiskWatcherConfig

impl PartialEq for DiskWatcherConfig

fn eq(&self, other: &DiskWatcherConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DiskWatcherConfig

impl TaskInput for DiskWatcherConfig

fn is_transient(&self) -> bool

This should return true if this object contains a [Vc] (or any subtype of [Vc]) pointing to a cell owned by a transient task.

fn resolve_input(&self) -> impl Future<Output = Result<Self, Error>> + Send

This method should resolve any [Vc]s nested inside of this object, cloning the object in the process. If the input is unresolved ([TaskInput::is_resolved]) a “local” resolution task is created that runs this method.

fn is_resolved(&self) -> bool

This should return true if there are any unresolved [Vc]s in the type.

impl TraceRawVcs for DiskWatcherConfig

fn trace_raw_vcs(&self, __context__: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>