Vixen
02b45cc4

IFileWatcher

interface Core/Vixen.Core.IO/Watch/FileWatcher.cs:7
csharp
public interface IFileWatcher

Watches part of the virtual file system and reports settled changes.

No guide page documents this yet — the page shows what the code says about itself.

Fields and properties (3)

  • VirtualPath Root

    The virtual path this watcher covers.

  • TimeSpan Debounce

    How long a path must be quiet before its change is reported.

  • bool HasOverflowed

    Whether events were lost since the last ClearOverflow, meaning the only correct response is to rescan.

Methods (3)

  • void Suppress(VirtualPath path)

    Ignores events for a path that this program is about to write.

  • int Drain(ICollection<FileChange> into)

    Takes every change whose debounce window has closed.

  • void ClearOverflow()

    Acknowledges an overflow after rescanning.

Used by (3)

  • FileWatcherVixen.Core.IO
  • EditorApplicationVixen.Editor.App
  • ScriptsModuleVixen.Editor.Scripts