Twitch.InternalRule

Documentation

type Action = FilePath -> UTCTime -> IO ()

The actions that are run when file events are triggered

type FileTest = FilePath -> UTCTime -> Bool

The test function to determine if a event Action should get fired

data InternalRule

Constructors

InternalRule

Fields

• name :: String

  A name for debugging mostly

• fileTest :: FileTest

  The test to determine if the rule actions should fire

• modify :: Action

  The action to run on Modify events

• add :: Action

  The action to run on Add events

• delete :: Action

  The action to run on Delete events

Instances

Show InternalRule

Defined in Twitch.InternalRule

Methods

showsPrec :: Int -> InternalRule -> ShowS

show :: InternalRule -> String

showList :: [InternalRule] -> ShowS

Default InternalRule

Defined in Twitch.InternalRule

Methods

def :: InternalRule

toInternalRule :: FilePath -> Rule -> Either RuleIssue InternalRule

data Config

Configuration to run the file watcher

Constructors

Config

Fields

• logger :: Issue -> IO ()

  A logger for the issues

• dirs :: [FilePath]

  The directories to watch

• watchConfig :: WatchConfig

  config for the file watcher

Instances

Show Config

Defined in Twitch.InternalRule

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Default Config

Defined in Twitch.InternalRule

Methods

def :: Config

data Issue

A sum type for the various issues that can be logged

Constructors

IEvent Event

logged every time an event is fired

IRuleFired Event InternalRule

logged every time an rule is fired

Instances

Show Issue

Defined in Twitch.InternalRule

Methods

showsPrec :: Int -> Issue -> ShowS

show :: Issue -> String

showList :: [Issue] -> ShowS

fireRule :: Event -> InternalRule -> IO ()

Run the Rule action associated with the an event

testAndFireRule :: Config -> Event -> InternalRule -> IO ()

Test to see if the rule should fire and fire it

setupRuleForDir :: Config -> WatchManager -> [InternalRule] -> FilePath -> IO ()

Start watching a directory, and run the rules on it.

setupRules :: Config -> [InternalRule] -> IO WatchManager

Setup all of the directory watches using the rules