ModuleCabal-3.18.1.0Haskell2010

Distribution.Simple.FileMonitor.Types

Types for monitoring files and directories.

Contents

Globs with respect to a root
File monitoring
Utility constructors of MonitorFilePath

Synopsis

data RootedGlob
data FilePathRoot
data Glob
data MonitorFilePath
data MonitorKindFile
data MonitorKindDir
value monitorFile
value monitorFileHashed
value monitorNonExistentFile
value monitorFileExistence
value monitorDirectory
value monitorNonExistentDirectory
value monitorDirectoryExistence
value monitorFileOrDirectory
value monitorFileGlob
value monitorFileGlobExistence
value monitorFileSearchPath
value monitorFileHashedSearchPath

PackageCabal-3.18.1.0
Exports18
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

Globs with respect to a root

datadata RootedGlob

Source#

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

Constructors

RootedGlob FilePathRoot Glob

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

Eq RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Parsec RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Pretty RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured RootedGlobDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep RootedGlob = D1 ('MetaData "RootedGlob" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-3089" 'False) (C1 ('MetaCons "RootedGlob" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePathRoot) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Glob)))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

datadata FilePathRoot

Constructors

FilePathRelative
FilePathRoot FilePath
e.g. "/", "c:" or result of takeDrive
FilePathHomeDir

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

Eq FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Parsec FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Pretty FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured FilePathRootDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep FilePathRoot = D1 ('MetaData "FilePathRoot" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-3089" 'False) (C1 ('MetaCons "FilePathRelative" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "FilePathRoot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "FilePathHomeDir" 'PrefixI 'False) U1))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

datadata Glob

Source#

A filepath specified by globbing.

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

Eq GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Show GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Generic GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Binary GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Parsec GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Pretty GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
Structured GlobDefined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal
type Rep Glob = D1 ('MetaData "Glob" "Distribution.Simple.Glob.Internal" "Cabal-3.18.1.0-3089" 'False) ((C1 ('MetaCons "GlobDir" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Glob)) :+: C1 ('MetaCons "GlobDirRecursive" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces))) :+: (C1 ('MetaCons "GlobFile" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces)) :+: C1 ('MetaCons "GlobDirTrailing" 'PrefixI 'False) U1))Defined in Cabal-3.18.1.0 · Distribution.Simple.Glob.Internal

File monitoring

datadata MonitorFilePath

Source#

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

MonitorFile
- monitorKindFile :: !MonitorKindFile
- monitorKindDir :: !MonitorKindDir
- monitorPath :: !FilePath
MonitorFileGlob
- monitorKindFile :: !MonitorKindFile
- monitorKindDir :: !MonitorKindDir
- monitorPathGlob :: !RootedGlob

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq MonitorFilePathDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show MonitorFilePathDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic MonitorFilePathDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary MonitorFilePathDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured MonitorFilePathDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep MonitorFilePath = D1 ('MetaData "MonitorFilePath" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-3089" 'False) (C1 ('MetaCons "MonitorFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitorKindFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindFile) :*: (S1 ('MetaSel ('Just "monitorKindDir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindDir) :*: S1 ('MetaSel ('Just "monitorPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilePath))) :+: C1 ('MetaCons "MonitorFileGlob" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitorKindFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindFile) :*: (S1 ('MetaSel ('Just "monitorKindDir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindDir) :*: S1 ('MetaSel ('Just "monitorPathGlob") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RootedGlob))))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

datadata MonitorKindFile

FileExists FileModTime FileHashed FileNotExists

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq MonitorKindFileDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show MonitorKindFileDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic MonitorKindFileDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary MonitorKindFileDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured MonitorKindFileDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep MonitorKindFile = D1 ('MetaData "MonitorKindFile" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-3089" 'False) ((C1 ('MetaCons "FileExists" 'PrefixI 'False) U1 :+: C1 ('MetaCons "FileModTime" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "FileHashed" 'PrefixI 'False) U1 :+: C1 ('MetaCons "FileNotExists" 'PrefixI 'False) U1))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

datadata MonitorKindDir

DirExists DirModTime DirNotExists

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq MonitorKindDirDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Show MonitorKindDirDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Generic MonitorKindDirDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Binary MonitorKindDirDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
Structured MonitorKindDirDefined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types
type Rep MonitorKindDir = D1 ('MetaData "MonitorKindDir" "Distribution.Simple.FileMonitor.Types" "Cabal-3.18.1.0-3089" 'False) (C1 ('MetaCons "DirExists" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "DirModTime" 'PrefixI 'False) U1 :+: C1 ('MetaCons "DirNotExists" 'PrefixI 'False) U1))Defined in Cabal-3.18.1.0 · Distribution.Simple.FileMonitor.Types

Utility constructors of MonitorFilePath

valuemonitorFile :: FilePath -> MonitorFilePath

Source#

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

Source#

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.

valuemonitorNonExistentFile :: FilePath -> MonitorFilePath

Source#

Monitor a single non-existent file for changes. The monitored file is considered to have changed if it exists.

valuemonitorFileExistence :: FilePath -> MonitorFilePath

Source#

Monitor a single file for existence only. The monitored file is considered to have changed if it no longer exists.

valuemonitorDirectory :: FilePath -> MonitorFilePath

Source#

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.

valuemonitorNonExistentDirectory :: FilePath -> MonitorFilePath

Source#

Monitor a single non-existent directory for changes. The monitored directory is considered to have changed if it exists.

valuemonitorDirectoryExistence :: FilePath -> MonitorFilePath

Source#

Monitor a single directory for existence. The monitored directory is considered to have changed only if it no longer exists.

valuemonitorFileOrDirectory :: FilePath -> MonitorFilePath

Source#

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

Source#

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

Source#

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).

valuemonitorFileSearchPath :: [FilePath] -> FilePath -> [MonitorFilePath]

Source#

Creates a list of files to monitor when you search for a file which unsuccessfully looked in notFoundAtPaths before finding it at foundAtPath.

valuemonitorFileHashedSearchPath :: [FilePath] -> FilePath -> [MonitorFilePath]

Source#

Similar to monitorFileSearchPath, but also instructs us to monitor the hash of the found file.