HORIZON HASKELLDocslts/ghc-10.0.xfc4e5982026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · fc4e598 · 2026-10-11

ModuleCabal-3.18.1.0Haskell2010

Distribution.Simple.FileMonitor.Types

Types for monitoring files and directories.

  • 6 types
  • 12 values
  • PackageCabal-3.18.1.0
  • Exports18
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceTypes.hs

Globs with respect to a root

3 declarations
datadata RootedGlob
#

A file path specified by globbing, relative to some root directory.

Constructors

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …
datadata FilePathRoot
#

Constructors

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …
datadata Glob
#

A filepath specified by globbing.

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …

File monitoring

3 declarations
datadata MonitorFilePath
#

A description of a file (or set of files) to monitor for changes.

Where file paths are relative they are relative to a common directory (e.g. project root), not necessarily the process current directory.

Constructors

Instances6Eq, Show, Generic, Binary, Structured, Rep
datadata MonitorKindFile
#
FileExistsFileModTimeFileHashedFileNotExists
Instances6Eq, Show, Generic, Binary, Structured, Rep
datadata MonitorKindDir
#
DirExistsDirModTimeDirNotExists
Instances6Eq, Show, Generic, Binary, Structured, Rep

Utility constructors of MonitorFilePath

valuemonitorFile :: FilePath -> MonitorFilePath
#

Monitor a single file for changes, based on its modification time. The monitored file is considered to have changed if it no longer exists or if its modification time has changed.

valuemonitorFileHashed :: FilePath -> MonitorFilePath
#

Monitor a single file for changes, based on its modification time and content hash. The monitored file is considered to have changed if it no longer exists or if its modification time and content hash have changed.

valuemonitorDirectory :: FilePath -> MonitorFilePath
#

Monitor a single directory for changes, based on its modification time. The monitored directory is considered to have changed if it no longer exists or if its modification time has changed.

valuemonitorFileOrDirectory :: FilePath -> MonitorFilePath
#

Monitor a single file or directory for changes, based on its modification time. The monitored file is considered to have changed if it no longer exists or if its modification time has changed.

valuemonitorFileGlob :: RootedGlob -> MonitorFilePath
#

Monitor a set of files (or directories) identified by a file glob. The monitored glob is considered to have changed if the set of files matching the glob changes (i.e. creations or deletions), or for files if the modification time and content hash of any matching file has changed.

valuemonitorFileGlobExistence :: RootedGlob -> MonitorFilePath
#

Monitor a set of files (or directories) identified by a file glob for existence only. The monitored glob is considered to have changed if the set of files matching the glob changes (i.e. creations or deletions).