Allows watching the file system for changes to directories and files by using the platform's WatchService.
- Companion
- object
Value members
Abstract methods
Stream of events for paths that have been registered or watched.
Stream of events for paths that have been registered or watched.
- Value Params
- pollTimeout
amount of time for which the underlying platform is polled for events
Registers for events on the specified path.
Registers for events on the specified path.
This is a low-level abstraction on the platform's Path#register. The supplied path must be
a directory and events are raised for only direct descendants of the path. Use watch for
a higher level API.
Returns a cancellation task that unregisters the path for events. Unregistration is optional -
the Watcher will free all resources when it is finalized. Unregistration is only needed
when a Watcher will continue to be used after unregistration.
- Value Params
- modifiers
modifiers to pass to the underlying
WatchServicewhen registering- path
directory to watch for events
- types
event types to register for; if
Nil, all standard event types are registered
- Returns
unregistration task
Registers for events on the specified path.
Registers for events on the specified path.
This is more feature-rich than the platform's Path#register. The supplied path may be
a file or directory and events may raised for all descendants of the path. Use register for
a lower-level API.
Returns a cancellation task that unregisters the path for events. Unregistration is optional -
the Watcher will free all resources when it is finalized. Unregistration is only needed
when a Watcher will continue to be used after unregistration.
- Value Params
- modifiers
modifiers to pass to the underlying
WatchServicewhen registering- path
file or directory to watch for events
- types
event types to register for; if
Nil, all standard event types are registered
- Returns
unregistration task