Watcher

fs2.io.Watcher

See theWatcher companion object

sealed abstract class Watcher[F[_]]

Allows watching the file system for changes to directories and files by using the platform's WatchService.

Attributes

Companion:: object
Source:: DeprecatedWatcher.scala
Graph
Supertypes: class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

Stream of events for paths that have been registered or watched.

Attributes

pollTimeout: amount of time for which the underlying platform is polled for events
Source:: DeprecatedWatcher.scala

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.

Attributes

modifiers: modifiers to pass to the underlying WatchService when registering
path: directory to watch for events
types: event types to register for; if Nil, all standard event types are registered
Returns:: unregistration task
Source:: DeprecatedWatcher.scala

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.

Attributes

modifiers: modifiers to pass to the underlying WatchService when 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
Source:: DeprecatedWatcher.scala

Generated with