Copyright	(c) Dong Han 2017-2020
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.IO.FileSystem.Watch

Description

This module provides fs watcher based on libuv's fs_event, we also maintain watch list if target OS doesn't support recursive watch(Linux's inotify).

-- start watching threads, cleanup watching threads automatically when finished.
withResource (initWatchDirs ["fold_to_be_watch"] True) $  srcf -> do
    -- dup a file event source
    src <- srcf
    -- print event to stdout
    runBIO $ src >|> sinkToIO printStd

Synopsis

data FileEvent
- = FileAdd CBytes
- | FileRemove CBytes
- | FileModify CBytes
watchDirs :: [CBytes] -> Bool -> (FileEvent -> IO ()) -> IO ()
initWatchDirs :: [CBytes] -> Bool -> Resource (IO (Source FileEvent))

Documentation

data FileEvent Source #

File event with path info.

Constructors

FileAdd CBytes
FileRemove CBytes
FileModify CBytes

Instances

Instances details

Eq FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Methods (==) :: FileEvent -> FileEvent -> Bool # (/=) :: FileEvent -> FileEvent -> Bool #
Ord FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Methods compare :: FileEvent -> FileEvent -> Ordering # (<) :: FileEvent -> FileEvent -> Bool # (<=) :: FileEvent -> FileEvent -> Bool # (>) :: FileEvent -> FileEvent -> Bool # (>=) :: FileEvent -> FileEvent -> Bool # max :: FileEvent -> FileEvent -> FileEvent # min :: FileEvent -> FileEvent -> FileEvent #
Read FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Methods readsPrec :: Int -> ReadS FileEvent # readList :: ReadS [FileEvent] # readPrec :: ReadPrec FileEvent # readListPrec :: ReadPrec [FileEvent] #
Show FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Methods showsPrec :: Int -> FileEvent -> ShowS # show :: FileEvent -> String # showList :: [FileEvent] -> ShowS #
Generic FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Associated Types type Rep FileEvent :: Type -> Type # Methods from :: FileEvent -> Rep FileEvent x # to :: Rep FileEvent x -> FileEvent #
JSON FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Methods fromValue :: Value -> Converter FileEvent # toValue :: FileEvent -> Value # encodeJSON :: FileEvent -> Builder () #
Print FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch Methods toUTF8BuilderP :: Int -> FileEvent -> Builder () #
type Rep FileEvent Source #
Instance details Defined in Z.IO.FileSystem.Watch type Rep FileEvent = D1 ('MetaData "FileEvent" "Z.IO.FileSystem.Watch" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" 'False) (C1 ('MetaCons "FileAdd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes)) :+: (C1 ('MetaCons "FileRemove" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes)) :+: C1 ('MetaCons "FileModify" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes))))

watchDirs Source #

Arguments

:: [CBytes]	Directories to be watched
-> Bool	recursively watch?
-> (FileEvent -> IO ())	Callback function to handle `FileEvent`
-> IO ()

Watching a list of given directories.

initWatchDirs Source #

Arguments

:: [CBytes]	watching list
-> Bool	recursively watch?
-> Resource (IO (Source FileEvent))

Start watching a list of given directories, stream version.