System.Directory.Watcher

Documentation

data EventType

Event type

Constructors

Added

Modified

Removed

Instances

Bounded EventType

Methods

minBound :: EventType

maxBound :: EventType

Enum EventType

Methods

succ :: EventType -> EventType

pred :: EventType -> EventType

toEnum :: Int -> EventType

fromEnum :: EventType -> Int

enumFrom :: EventType -> [EventType]

enumFromThen :: EventType -> EventType -> [EventType]

enumFromTo :: EventType -> EventType -> [EventType]

enumFromThenTo :: EventType -> EventType -> EventType -> [EventType]

Eq EventType

Methods

(==) :: EventType -> EventType -> Bool

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

Ord EventType

Methods

compare :: EventType -> EventType -> Ordering

(<) :: EventType -> EventType -> Bool

(<=) :: EventType -> EventType -> Bool

(>) :: EventType -> EventType -> Bool

(>=) :: EventType -> EventType -> Bool

max :: EventType -> EventType -> EventType

min :: EventType -> EventType -> EventType

Read EventType

Methods

readsPrec :: Int -> ReadS EventType

readList :: ReadS [EventType]

readPrec :: ReadPrec EventType

readListPrec :: ReadPrec [EventType]

Show EventType

Methods

showsPrec :: Int -> EventType -> ShowS

show :: EventType -> String

showList :: [EventType] -> ShowS

data Event

Event

Constructors

Event

Fields

• _eventType :: EventType
• _eventPath :: FilePath
• _eventTime :: POSIXTime

Instances

Eq Event

Methods

(==) :: Event -> Event -> Bool

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

Ord Event

Methods

compare :: Event -> Event -> Ordering

(<) :: Event -> Event -> Bool

(<=) :: Event -> Event -> Bool

(>) :: Event -> Event -> Bool

(>=) :: Event -> Event -> Bool

max :: Event -> Event -> Event

min :: Event -> Event -> Event

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

eventType :: Lens' Event EventType

eventPath :: Lens' Event FilePath

eventTime :: Lens' Event POSIXTime

data Watcher a

Directories watcher

Constructors

Watcher

Fields

• watcherDirs :: MVar (Map FilePath (Bool, IO ()))

  Map from directory to watch stopper

• watcherMan :: WatchManager
• watcherChan :: Chan (a, Event)

withWatcher :: (Watcher a -> IO b) -> IO b

Create watcher

watchDir :: Watcher a -> FilePath -> (Event -> Bool) -> a -> IO ()

Watch directory

watchDir_ :: Watcher () -> FilePath -> (Event -> Bool) -> IO ()

unwatchDir :: Watcher a -> FilePath -> IO Bool

Unwatch directory, return False, if not watched

isWatchingDir :: Watcher a -> FilePath -> IO Bool

Check if we are watching dir

watchTree :: Watcher a -> FilePath -> (Event -> Bool) -> a -> IO ()

Watch directory tree

watchTree_ :: Watcher () -> FilePath -> (Event -> Bool) -> IO ()

unwatchTree :: Watcher a -> FilePath -> IO Bool

Unwatch directory tree

isWatchingTree :: Watcher a -> FilePath -> IO Bool

Check if we are watching tree

Working with events

readEvent :: Watcher a -> IO (a, Event)

Read next event

eventGroup :: Watcher a -> NominalDiffTime -> ([(a, Event)] -> IO ()) -> IO ()

Get event group

onEvents :: Watcher a -> NominalDiffTime -> ([(a, Event)] -> IO ()) -> IO ()

Process all events

onEvents_ :: Watcher a -> ([(a, Event)] -> IO ()) -> IO ()

Process all events