-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Folder watching as a Streamly stream.
--   
--   Provides Streamly streams for both single-level and recursive folder
--   watching. Also contains a principled and compositional system for
--   filtering file system events.
@package streamly-fsnotify
@version 2.0


-- | <b>Example</b>
--   
--   Here is a program which watches <tt>/home/georgefst/c-project</tt> and
--   any of its subdirectories for added or modified C source files (which
--   we take to be anything with a <tt>.c</tt> extension). This program
--   then writes that the event occurred, to what file, and when, forever.
--   
--   <pre>
--   import Data.Functor.Contravariant (Predicate (Predicate))
--   import Streamly.Data.Fold qualified as SF
--   import Streamly.Data.Stream.Prelude qualified as SP
--   import System.FilePath (isExtensionOf, (&lt;/&gt;))
--   
--   import Streamly.FSNotify
--   
--   isCSourceFile :: Predicate Event
--   isCSourceFile = Predicate \e -&gt;
--       "c" `isExtensionOf` eventPath e &amp;&amp; eventIsDirectory e == IsFile
--   
--   notDeletion :: Predicate Event
--   notDeletion = Predicate \case
--       Removed{} -&gt; False
--       _ -&gt; True
--   
--   srcPath :: FilePath
--   srcPath = "/" &lt;/&gt; "home" &lt;/&gt; "gthomas" &lt;/&gt; "c-project"
--   
--   main :: IO ()
--   main = SP.fold (SF.drainMapM go) $ watchTree srcPath $ isCSourceFile &lt;&gt; notDeletion
--     where
--       go = \case
--           Added p t _ -&gt; putStrLn $ "Created: " ++ show p ++ " at " ++ show t
--           Modified p t _ -&gt; putStrLn $ "Modified: " ++ show p ++ " at " ++ show t
--           _ -&gt; pure ()
--   </pre>
module Streamly.FSNotify

-- | A file event reported by a file watcher. Each event contains the
--   canonical path for the file and a timestamp guaranteed to be after the
--   event occurred (timestamps represent current time when FSEvents
--   receives it from the OS and/or platform-specific Haskell modules).
data Event
Added :: FilePath -> UTCTime -> EventIsDirectory -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory
Modified :: FilePath -> UTCTime -> EventIsDirectory -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory
ModifiedAttributes :: FilePath -> UTCTime -> EventIsDirectory -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory
Removed :: FilePath -> UTCTime -> EventIsDirectory -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory

-- | Note: Linux-only
WatchedDirectoryRemoved :: FilePath -> UTCTime -> EventIsDirectory -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory

-- | Note: Linux-only
CloseWrite :: FilePath -> UTCTime -> EventIsDirectory -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory

-- | Note: Linux-only
Unknown :: FilePath -> UTCTime -> EventIsDirectory -> String -> Event
[eventPath] :: Event -> FilePath
[eventTime] :: Event -> UTCTime
[eventIsDirectory] :: Event -> EventIsDirectory
[eventString] :: Event -> String
data EventIsDirectory
IsFile :: EventIsDirectory
IsDirectory :: EventIsDirectory

-- | Watch a given directory, but only at one level (thus, subdirectories
--   will <b>not</b> be watched recursively).
watchDir :: (MonadAsync m, MonadCatch m) => FilePath -> Predicate Event -> Stream m Event

-- | Watch a given directory recursively (thus, subdirectories will also
--   have their contents watched).
watchTree :: (MonadAsync m, MonadCatch m) => FilePath -> Predicate Event -> Stream m Event