System.Plugins.Hotswap

Documentation

data Plugin a

Constructors

Plugin

Fields

pluginObject :: FilePath

Path to object

pluginIncludes :: [FilePath]

Include paths.

pluginDataName :: String

Name of the symbol to find.

pluginData :: IORef a

Loaded data.

pluginModule :: IORef Module

Loaded module.

newPlugin :: FilePath -> [FilePath] -> String -> IO (Plugin a)

Create a new plugin, expecting a type. Don't use this to reload plugins.

usePlugin :: Plugin (a -> b) -> a -> IO b

usePlugin provides a simple way to use plugins of type 'Plugin (a -> b)', ie, only single argumented ones.

usePluginIO :: Plugin (a -> IO b) -> a -> IO b

usePlugin for plugins returning IO.

runPlugin :: Plugin (IO a) -> IO a

runPlugin runs an 'IO a' returning Plugin.

reloadPlugin :: Plugin a -> IO ()

Reload a plugin in-place.

readPlugin :: Plugin a -> IO a

Read the pluginData IORef.

withPlugin :: Plugin a -> (a -> a) -> IO ()

withPlugin provides a way to run a function on a plugin, modifying the plugin in-place.

withPluginIO :: Plugin a -> (a -> IO a) -> IO ()

withPlugin for functions returning IO.

putPlugin :: Plugin a -> a -> IO ()

Replace the contents of the pluginData.