System.INotify

hinotify-0.4.1: Haskell binding to inotify

Copyright | (c) Lennart Kolmodin 2006-2012
License | BSD3
Maintainer | kolmodin@gmail.com
Stability | experimental
Portability | hc portable, linux only
Safe Haskell | Safe-Inferred
Language | Haskell2010

System.INotify

Description

A Haskell binding to INotify. See http://www.kernel.org/pub/linux/kernel/people/rml/inotify/ and `man inotify`.

Use `initINotify` to get a `INotify`, then use `addWatch` to add a watch on a file or directory. Select which events you're interested in with `EventVariety`, which corresponds to the `Event` events.

Use `removeWatch` once you don't want to watch a file any more.

# Documentation

initINotify :: IO INotify #

killINotify :: INotify -> IO () #

withINotify :: (INotify -> IO a) -> IO a #

addWatch :: INotify -> [EventVariety] -> RawFilePath -> (Event -> IO ()) -> IO WatchDescriptor #

removeWatch :: WatchDescriptor -> IO () #

data INotify #

#### Instances

Instances details

Show INotify # |
Instance details Defined in System.INotify Methods showsPrec :: Int -> INotify -> ShowS # show :: INotify -> String # showList :: [INotify] -> ShowS #
Eq INotify # |
Instance details Defined in System.INotify Methods (==) :: INotify -> INotify -> Bool # (/=) :: INotify -> INotify -> Bool #

data WatchDescriptor #

#### Instances

Instances details

Show WatchDescriptor # |
Instance details Defined in System.INotify Methods showsPrec :: Int -> WatchDescriptor -> ShowS # show :: WatchDescriptor -> String # showList :: [WatchDescriptor] -> ShowS #
Eq WatchDescriptor # |
Instance details Defined in System.INotify Methods (==) :: WatchDescriptor -> WatchDescriptor -> Bool # (/=) :: WatchDescriptor -> WatchDescriptor -> Bool #

data Event #

Constructors

Accessed | A file was accessed. `Accessed isDirectory file`
Fields isDirectory :: Bool maybeFilePath :: Maybe RawFilePath
Modified | A file was modified. `Modified isDirectory file`
Fields isDirectory :: Bool maybeFilePath :: Maybe RawFilePath
Attributes | A files attributes where changed. `Attributes isDirectory file`
Fields isDirectory :: Bool maybeFilePath :: Maybe RawFilePath
Closed | A file was closed. `Closed isDirectory file wasWriteable`
Fields isDirectory :: Bool maybeFilePath :: Maybe RawFilePath wasWriteable :: Bool
Opened | A file was opened. `Opened isDirectory maybeFilePath`
Fields isDirectory :: Bool maybeFilePath :: Maybe RawFilePath
MovedOut | A file was moved away from the watched dir. `MovedFrom isDirectory from cookie`
Fields isDirectory :: Bool filePath :: RawFilePath moveCookie :: Cookie
MovedIn | A file was moved into the watched dir. `MovedTo isDirectory to cookie`
Fields isDirectory :: Bool filePath :: RawFilePath moveCookie :: Cookie
MovedSelf | The watched file was moved. `MovedSelf isDirectory`
Fields isDirectory :: Bool
Created | A file was created. `Created isDirectory file`
Fields isDirectory :: Bool filePath :: RawFilePath
Deleted | A file was deleted. `Deleted isDirectory file`
Fields isDirectory :: Bool filePath :: RawFilePath
DeletedSelf | The file watched was deleted.
Unmounted | The file watched was unmounted.
QOverflow | The queue overflowed.
Ignored |
Unknown FDEvent |

#### Instances

Instances details

Show Event # |
Instance details Defined in System.INotify Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
Eq Event # |
Instance details Defined in System.INotify Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #

data EventVariety #

Constructors

Access |
Modify |
Attrib |
Close |
CloseWrite |
CloseNoWrite |
Open |
Move |
MoveIn |
MoveOut |
MoveSelf |
Create |
Delete |
DeleteSelf |
OnlyDir |
NoSymlink |
MaskAdd |
OneShot |
AllEvents |

#### Instances

Instances details

Eq EventVariety # |
Instance details Defined in System.INotify Methods (==) :: EventVariety -> EventVariety -> Bool # (/=) :: EventVariety -> EventVariety -> Bool #

data Cookie #

#### Instances

Instances details

Show Cookie # |
Instance details Defined in System.INotify Methods showsPrec :: Int -> Cookie -> ShowS # show :: Cookie -> String # showList :: [Cookie] -> ShowS #
Eq Cookie # |
Instance details Defined in System.INotify Methods (==) :: Cookie -> Cookie -> Bool # (/=) :: Cookie -> Cookie -> Bool #
Ord Cookie # |
Instance details Defined in System.INotify Methods compare :: Cookie -> Cookie -> Ordering # (<) :: Cookie -> Cookie -> Bool # (<=) :: Cookie -> Cookie -> Bool # (>) :: Cookie -> Cookie -> Bool # (>=) :: Cookie -> Cookie -> Bool # max :: Cookie -> Cookie -> Cookie # min :: Cookie -> Cookie -> Cookie #