Distribution.Simple.FileMonitor.Types

Types for monitoring files and directories.

Globs with respect to a root

data RootedGlob

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

Constructors

RootedGlob

Fields

• FilePathRoot

  what the glob is relative to

• Glob

  the glob

Instances

Parsec RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

parsec :: CabalParsing m => m RootedGlob

Pretty RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

pretty :: RootedGlob -> Doc

prettyVersioned :: CabalSpecVersion -> RootedGlob -> Doc

Structured RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy RootedGlob -> Structure

structureHash' :: Tagged RootedGlob MD5

Generic RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep RootedGlob :: Type -> Type

Methods

from :: RootedGlob -> Rep RootedGlob x

to :: Rep RootedGlob x -> RootedGlob

Show RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> RootedGlob -> ShowS

show :: RootedGlob -> String

showList :: [RootedGlob] -> ShowS

Binary RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: RootedGlob -> Put

get :: Get RootedGlob

putList :: [RootedGlob] -> Put

Eq RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: RootedGlob -> RootedGlob -> Bool

(/=) :: RootedGlob -> RootedGlob -> Bool

type Rep RootedGlob

Defined in Distribution.Simple.FileMonitor.Types

type Rep RootedGlob = D1 ('MetaData "RootedGlob" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "RootedGlob" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePathRoot) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Glob)))

data FilePathRoot

Constructors

FilePathRelative

FilePathRoot FilePath

e.g. "/", "c:" or result of takeDrive

FilePathHomeDir

Instances

Parsec FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

parsec :: CabalParsing m => m FilePathRoot

Pretty FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

pretty :: FilePathRoot -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathRoot -> Doc

Structured FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy FilePathRoot -> Structure

structureHash' :: Tagged FilePathRoot MD5

Generic FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep FilePathRoot :: Type -> Type

Methods

from :: FilePathRoot -> Rep FilePathRoot x

to :: Rep FilePathRoot x -> FilePathRoot

Show FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> FilePathRoot -> ShowS

show :: FilePathRoot -> String

showList :: [FilePathRoot] -> ShowS

Binary FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: FilePathRoot -> Put

get :: Get FilePathRoot

putList :: [FilePathRoot] -> Put

Eq FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: FilePathRoot -> FilePathRoot -> Bool

(/=) :: FilePathRoot -> FilePathRoot -> Bool

type Rep FilePathRoot

Defined in Distribution.Simple.FileMonitor.Types

type Rep FilePathRoot = D1 ('MetaData "FilePathRoot" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "FilePathRelative" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "FilePathRoot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "FilePathHomeDir" 'PrefixI 'False) (U1 :: Type -> Type)))

data Glob

A filepath specified by globbing.

Instances

Parsec Glob

Defined in Distribution.Simple.Glob.Internal

Methods

parsec :: CabalParsing m => m Glob

Pretty Glob

Defined in Distribution.Simple.Glob.Internal

Methods

pretty :: Glob -> Doc

prettyVersioned :: CabalSpecVersion -> Glob -> Doc

Structured Glob

Defined in Distribution.Simple.Glob.Internal

Methods

structure :: Proxy Glob -> Structure

structureHash' :: Tagged Glob MD5

Generic Glob

Defined in Distribution.Simple.Glob.Internal

Associated Types

type Rep Glob :: Type -> Type

Methods

from :: Glob -> Rep Glob x

to :: Rep Glob x -> Glob

Show Glob

Defined in Distribution.Simple.Glob.Internal

Methods

showsPrec :: Int -> Glob -> ShowS

show :: Glob -> String

showList :: [Glob] -> ShowS

Binary Glob

Defined in Distribution.Simple.Glob.Internal

Methods

put :: Glob -> Put

get :: Get Glob

putList :: [Glob] -> Put

Eq Glob

Defined in Distribution.Simple.Glob.Internal

Methods

(==) :: Glob -> Glob -> Bool

(/=) :: Glob -> Glob -> Bool

type Rep Glob

Defined in Distribution.Simple.Glob.Internal

type Rep Glob = D1 ('MetaData "Glob" "Distribution.Simple.Glob.Internal" "Cabal-3.14.0.0-inplace" 'False) ((C1 ('MetaCons "GlobDir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Glob)) :+: C1 ('MetaCons "GlobDirRecursive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces))) :+: (C1 ('MetaCons "GlobFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GlobPieces)) :+: C1 ('MetaCons "GlobDirTrailing" 'PrefixI 'False) (U1 :: Type -> Type)))

File monitoring

data 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

MonitorFile

Fields

• monitorKindFile :: !MonitorKindFile
• monitorKindDir :: !MonitorKindDir
• monitorPath :: !FilePath

MonitorFileGlob

Fields

• monitorKindFile :: !MonitorKindFile
• monitorKindDir :: !MonitorKindDir
• monitorPathGlob :: !RootedGlob

Instances

Structured MonitorFilePath

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy MonitorFilePath -> Structure

structureHash' :: Tagged MonitorFilePath MD5

Generic MonitorFilePath

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep MonitorFilePath :: Type -> Type

Methods

from :: MonitorFilePath -> Rep MonitorFilePath x

to :: Rep MonitorFilePath x -> MonitorFilePath

Show MonitorFilePath

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> MonitorFilePath -> ShowS

show :: MonitorFilePath -> String

showList :: [MonitorFilePath] -> ShowS

Binary MonitorFilePath

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: MonitorFilePath -> Put

get :: Get MonitorFilePath

putList :: [MonitorFilePath] -> Put

Eq MonitorFilePath

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: MonitorFilePath -> MonitorFilePath -> Bool

(/=) :: MonitorFilePath -> MonitorFilePath -> Bool

type Rep MonitorFilePath

Defined in Distribution.Simple.FileMonitor.Types

type Rep MonitorFilePath = D1 ('MetaData "MonitorFilePath" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.0.0-inplace" '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))))

data MonitorKindFile

Constructors

FileExists

FileModTime

FileHashed

FileNotExists

Instances

Structured MonitorKindFile

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy MonitorKindFile -> Structure

structureHash' :: Tagged MonitorKindFile MD5

Generic MonitorKindFile

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep MonitorKindFile :: Type -> Type

Methods

from :: MonitorKindFile -> Rep MonitorKindFile x

to :: Rep MonitorKindFile x -> MonitorKindFile

Show MonitorKindFile

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> MonitorKindFile -> ShowS

show :: MonitorKindFile -> String

showList :: [MonitorKindFile] -> ShowS

Binary MonitorKindFile

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: MonitorKindFile -> Put

get :: Get MonitorKindFile

putList :: [MonitorKindFile] -> Put

Eq MonitorKindFile

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: MonitorKindFile -> MonitorKindFile -> Bool

(/=) :: MonitorKindFile -> MonitorKindFile -> Bool

type Rep MonitorKindFile

Defined in Distribution.Simple.FileMonitor.Types

type Rep MonitorKindFile = D1 ('MetaData "MonitorKindFile" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.0.0-inplace" 'False) ((C1 ('MetaCons "FileExists" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FileModTime" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FileHashed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FileNotExists" 'PrefixI 'False) (U1 :: Type -> Type)))

data MonitorKindDir

Constructors

DirExists

DirModTime

DirNotExists

Instances

Structured MonitorKindDir

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy MonitorKindDir -> Structure

structureHash' :: Tagged MonitorKindDir MD5

Generic MonitorKindDir

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep MonitorKindDir :: Type -> Type

Methods

from :: MonitorKindDir -> Rep MonitorKindDir x

to :: Rep MonitorKindDir x -> MonitorKindDir

Show MonitorKindDir

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> MonitorKindDir -> ShowS

show :: MonitorKindDir -> String

showList :: [MonitorKindDir] -> ShowS

Binary MonitorKindDir

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: MonitorKindDir -> Put

get :: Get MonitorKindDir

putList :: [MonitorKindDir] -> Put

Eq MonitorKindDir

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: MonitorKindDir -> MonitorKindDir -> Bool

(/=) :: MonitorKindDir -> MonitorKindDir -> Bool

type Rep MonitorKindDir

Defined in Distribution.Simple.FileMonitor.Types

type Rep MonitorKindDir = D1 ('MetaData "MonitorKindDir" "Distribution.Simple.FileMonitor.Types" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "DirExists" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DirModTime" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DirNotExists" 'PrefixI 'False) (U1 :: Type -> Type)))

Utility constructors of MonitorFilePath

monitorFile :: 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.

monitorFileHashed :: 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.

monitorNonExistentFile :: FilePath -> MonitorFilePath

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

monitorFileExistence :: FilePath -> MonitorFilePath

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

monitorDirectory :: 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.

monitorNonExistentDirectory :: FilePath -> MonitorFilePath

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

monitorDirectoryExistence :: FilePath -> MonitorFilePath

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

monitorFileOrDirectory :: 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.

monitorFileGlob :: 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.

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

monitorFileSearchPath :: [FilePath] -> FilePath -> [MonitorFilePath]

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

monitorFileHashedSearchPath :: [FilePath] -> FilePath -> [MonitorFilePath]

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