/usr/share/doc/libghc-fsnotify-doc/html/System-FSNotify.html is in libghc-fsnotify-doc 0.2.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>System.FSNotify</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_System-FSNotify.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/System-FSNotify.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">fsnotify-0.2.1.1: Cross platform library for file change notification.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">System.FSNotify</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Events</a></li><li><a href="#g:2">Starting/Stopping</a></li><li><a href="#g:3">Watching</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>NOTE: This library does not currently report changes made to directories,
only files within watched directories.</p><p>Minimal example:</p><pre>{-# LANGUAGE OverloadedStrings #-} -- for FilePath literals
import System.FSNotify
import Control.Concurrent (threadDelay)
import Control.Monad (forever)
main =
withManager $ \mgr -> do
-- start a watching job (in the background)
watchDir
mgr -- manager
"." -- directory to watch
(const True) -- predicate
print -- action
-- sleep forever (until interrupted)
forever $ threadDelay 1000000</pre></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Event">Event</a><ul class="subs"><li>= <a href="#v:Added">Added</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></li><li>| <a href="#v:Modified">Modified</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></li><li>| <a href="#v:Removed">Removed</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:EventChannel">EventChannel</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Control-Concurrent-Chan.html#t:Chan">Chan</a> <a href="System-FSNotify.html#t:Event">Event</a></li><li class="src short"><a href="#v:eventTime">eventTime</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></li><li class="src short"><a href="#v:eventPath">eventPath</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:Action">Action</a> = <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">type</span> <a href="#t:ActionPredicate">ActionPredicate</a> = <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:WatchManager">WatchManager</a></li><li class="src short"><a href="#v:withManager">withManager</a> :: (<a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:startManager">startManager</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:WatchManager">WatchManager</a></li><li class="src short"><a href="#v:stopManager">stopManager</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:defaultConfig">defaultConfig</a> :: <a href="System-FSNotify.html#t:WatchConfig">WatchConfig</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:WatchConfig">WatchConfig</a> = <a href="#v:WatchConfig">WatchConfig</a> {<ul class="subs"><li><a href="#v:confDebounce">confDebounce</a> :: <a href="System-FSNotify.html#t:Debounce">Debounce</a></li><li><a href="#v:confPollInterval">confPollInterval</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:confUsePolling">confUsePolling</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:Debounce">Debounce</a><ul class="subs"><li>= <a href="#v:DebounceDefault">DebounceDefault</a></li><li>| <a href="#v:Debounce">Debounce</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:NominalDiffTime">NominalDiffTime</a></li><li>| <a href="#v:NoDebounce">NoDebounce</a></li></ul></li><li class="src short"><a href="#v:withManagerConf">withManagerConf</a> :: <a href="System-FSNotify.html#t:WatchConfig">WatchConfig</a> -> (<a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:startManagerConf">startManagerConf</a> :: <a href="System-FSNotify.html#t:WatchConfig">WatchConfig</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:WatchManager">WatchManager</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:StopListening">StopListening</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:isPollingManager">isPollingManager</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:watchDir">watchDir</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:Action">Action</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a></li><li class="src short"><a href="#v:watchDirChan">watchDirChan</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:EventChannel">EventChannel</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a></li><li class="src short"><a href="#v:watchTree">watchTree</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:Action">Action</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a></li><li class="src short"><a href="#v:watchTreeChan">watchTreeChan</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:EventChannel">EventChannel</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a></li></ul></div><div id="interface"><h1 id="g:1">Events</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Event" class="def">Event</a> <a href="src/System-FSNotify-Types.html#Event" class="link">Source</a> <a href="#t:Event" class="selflink">#</a></p><div class="doc"><p>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).</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Added" class="def">Added</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:Modified" class="def">Modified</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:Removed" class="def">Removed</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Event" class="caption collapser" onclick="toggleSection('i:Event')">Instances</p><div id="section.i:Event" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Event:Eq:1" class="instance expander" onclick="toggleSection('i:id:Event:Eq:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="System-FSNotify.html#t:Event">Event</a></span> <a href="src/System-FSNotify-Types.html#line-37" class="link">Source</a> <a href="#t:Event" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Event:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Event:Show:2" class="instance expander" onclick="toggleSection('i:id:Event:Show:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:Show">Show</a> <a href="System-FSNotify.html#t:Event">Event</a></span> <a href="src/System-FSNotify-Types.html#line-37" class="link">Source</a> <a href="#t:Event" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Event:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a> -> <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="System-FSNotify.html#t:Event">Event</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:EventChannel" class="def">EventChannel</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Control-Concurrent-Chan.html#t:Chan">Chan</a> <a href="System-FSNotify.html#t:Event">Event</a> <a href="src/System-FSNotify-Types.html#EventChannel" class="link">Source</a> <a href="#t:EventChannel" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:eventTime" class="def">eventTime</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> <a href="src/System-FSNotify-Types.html#eventTime" class="link">Source</a> <a href="#v:eventTime" class="selflink">#</a></p><div class="doc"><p>Helper for extracting the time associated with an event.</p></div></div><div class="top"><p class="src"><a id="v:eventPath" class="def">eventPath</a> :: <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> <a href="src/System-FSNotify-Types.html#eventPath" class="link">Source</a> <a href="#v:eventPath" class="selflink">#</a></p><div class="doc"><p>Helper for extracting the path associated with an event.</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:Action" class="def">Action</a> = <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> () <a href="src/System-FSNotify-Types.html#Action" class="link">Source</a> <a href="#t:Action" class="selflink">#</a></p><div class="doc"><p>An action to be performed in response to an event.</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:ActionPredicate" class="def">ActionPredicate</a> = <a href="System-FSNotify.html#t:Event">Event</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/System-FSNotify-Types.html#ActionPredicate" class="link">Source</a> <a href="#t:ActionPredicate" class="selflink">#</a></p><div class="doc"><p>A predicate used to determine whether to act on an event.</p></div></div><h1 id="g:2">Starting/Stopping</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:WatchManager" class="def">WatchManager</a> <a href="src/System-FSNotify.html#WatchManager" class="link">Source</a> <a href="#t:WatchManager" class="selflink">#</a></p><div class="doc"><p>Watch manager. You need one in order to create watching jobs.</p></div></div><div class="top"><p class="src"><a id="v:withManager" class="def">withManager</a> :: (<a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a <a href="src/System-FSNotify.html#withManager" class="link">Source</a> <a href="#v:withManager" class="selflink">#</a></p><div class="doc"><p>Perform an IO action with a WatchManager in place.
Tear down the WatchManager after the action is complete.</p></div></div><div class="top"><p class="src"><a id="v:startManager" class="def">startManager</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> <a href="src/System-FSNotify.html#startManager" class="link">Source</a> <a href="#v:startManager" class="selflink">#</a></p><div class="doc"><p>Start a file watch manager.
Directories can only be watched when they are managed by a started watch
watch manager.
When finished watching. you must release resources via <code><a href="System-FSNotify.html#v:stopManager">stopManager</a></code>.
It is preferrable if possible to use <code><a href="System-FSNotify.html#v:withManager">withManager</a></code> to handle this
automatically.</p></div></div><div class="top"><p class="src"><a id="v:stopManager" class="def">stopManager</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> () <a href="src/System-FSNotify.html#stopManager" class="link">Source</a> <a href="#v:stopManager" class="selflink">#</a></p><div class="doc"><p>Stop a file watch manager.
Stopping a watch manager will immediately stop
watching for files and free resources.</p></div></div><div class="top"><p class="src"><a id="v:defaultConfig" class="def">defaultConfig</a> :: <a href="System-FSNotify.html#t:WatchConfig">WatchConfig</a> <a href="src/System-FSNotify.html#defaultConfig" class="link">Source</a> <a href="#v:defaultConfig" class="selflink">#</a></p><div class="doc"><p>Default configuration</p><ul><li>Debouncing is enabled with a time interval of 1 millisecond</li><li>Polling is disabled</li><li>The polling interval defaults to 1 second</li></ul></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:WatchConfig" class="def">WatchConfig</a> <a href="src/System-FSNotify-Types.html#WatchConfig" class="link">Source</a> <a href="#t:WatchConfig" class="selflink">#</a></p><div class="doc"><p>Watch configuration</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:WatchConfig" class="def">WatchConfig</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:confDebounce" class="def">confDebounce</a> :: <a href="System-FSNotify.html#t:Debounce">Debounce</a></dfn><div class="doc"><p>Debounce configuration</p></div></li><li><dfn class="src"><a id="v:confPollInterval" class="def">confPollInterval</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc"><p>Polling interval if polling is used (microseconds)</p></div></li><li><dfn class="src"><a id="v:confUsePolling" class="def">confUsePolling</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>Force use of polling, even if a more effective method may be
available. This is mostly for testing purposes.</p></div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Debounce" class="def">Debounce</a> <a href="src/System-FSNotify-Types.html#Debounce" class="link">Source</a> <a href="#t:Debounce" class="selflink">#</a></p><div class="doc"><p>This specifies whether multiple events from the same file should be
collapsed together, and how close is close enough.</p><p>This is performed by ignoring any event that occurs to the same file
until the specified time interval has elapsed.</p><p>Note that the current debouncing logic may fail to report certain changes
to a file, potentially leaving your program in a state that is not
consistent with the filesystem.</p><p>Make sure that if you are using this feature, all changes you make as a
result of an <code><a href="System-FSNotify.html#t:Event">Event</a></code> notification are both non-essential and idempotent.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:DebounceDefault" class="def">DebounceDefault</a></td><td class="doc"><p>perform debouncing based on the default time interval of 1 millisecond</p></td></tr><tr><td class="src"><a id="v:Debounce" class="def">Debounce</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.6.0.1/Data-Time-Clock.html#t:NominalDiffTime">NominalDiffTime</a></td><td class="doc"><p>perform debouncing based on the specified time interval</p></td></tr><tr><td class="src"><a id="v:NoDebounce" class="def">NoDebounce</a></td><td class="doc"><p>do not perform debouncing</p></td></tr></table></div></div><div class="top"><p class="src"><a id="v:withManagerConf" class="def">withManagerConf</a> :: <a href="System-FSNotify.html#t:WatchConfig">WatchConfig</a> -> (<a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> a <a href="src/System-FSNotify.html#withManagerConf" class="link">Source</a> <a href="#v:withManagerConf" class="selflink">#</a></p><div class="doc"><p>Like <code><a href="System-FSNotify.html#v:withManager">withManager</a></code>, but configurable</p></div></div><div class="top"><p class="src"><a id="v:startManagerConf" class="def">startManagerConf</a> :: <a href="System-FSNotify.html#t:WatchConfig">WatchConfig</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> <a href="src/System-FSNotify.html#startManagerConf" class="link">Source</a> <a href="#v:startManagerConf" class="selflink">#</a></p><div class="doc"><p>Like <code><a href="System-FSNotify.html#v:startManager">startManager</a></code>, but configurable</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:StopListening" class="def">StopListening</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> () <a href="src/System-FSNotify-Listener.html#StopListening" class="link">Source</a> <a href="#t:StopListening" class="selflink">#</a></p><div class="doc"><p>An action that cancels a watching/listening job</p></div></div><div class="top"><p class="src"><a id="v:isPollingManager" class="def">isPollingManager</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/System-FSNotify.html#isPollingManager" class="link">Source</a> <a href="#v:isPollingManager" class="selflink">#</a></p><div class="doc"><p>Does this manager use polling?</p></div></div><h1 id="g:3">Watching</h1><div class="top"><p class="src"><a id="v:watchDir" class="def">watchDir</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:Action">Action</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a> <a href="src/System-FSNotify.html#watchDir" class="link">Source</a> <a href="#v:watchDir" class="selflink">#</a></p><div class="doc"><p>Watch the immediate contents of a directory by committing an Action for each event.
Watching the immediate contents of a directory will only report events
associated with files within the specified directory, and not files
within its subdirectories. No two events pertaining to the same FilePath will
be executed concurrently.</p></div></div><div class="top"><p class="src"><a id="v:watchDirChan" class="def">watchDirChan</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:EventChannel">EventChannel</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a> <a href="src/System-FSNotify.html#watchDirChan" class="link">Source</a> <a href="#v:watchDirChan" class="selflink">#</a></p><div class="doc"><p>Watch the immediate contents of a directory by streaming events to a Chan.
Watching the immediate contents of a directory will only report events
associated with files within the specified directory, and not files
within its subdirectories.</p></div></div><div class="top"><p class="src"><a id="v:watchTree" class="def">watchTree</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:Action">Action</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a> <a href="src/System-FSNotify.html#watchTree" class="link">Source</a> <a href="#v:watchTree" class="selflink">#</a></p><div class="doc"><p>Watch all the contents of a directory by committing an Action for each event.
Watching all the contents of a directory will report events associated with
files within the specified directory and its subdirectories. No two events
pertaining to the same FilePath will be executed concurrently.</p></div></div><div class="top"><p class="src"><a id="v:watchTreeChan" class="def">watchTreeChan</a> :: <a href="System-FSNotify.html#t:WatchManager">WatchManager</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="System-FSNotify.html#t:ActionPredicate">ActionPredicate</a> -> <a href="System-FSNotify.html#t:EventChannel">EventChannel</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> <a href="System-FSNotify.html#t:StopListening">StopListening</a> <a href="src/System-FSNotify.html#watchTreeChan" class="link">Source</a> <a href="#v:watchTreeChan" class="selflink">#</a></p><div class="doc"><p>Watch all the contents of a directory by streaming events to a Chan.
Watching all the contents of a directory will report events associated with
files within the specified directory and its subdirectories.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.3</p></div></body></html>
|