Boots

Boot application by using plugins.

>>> booting (pluginSimple "application") (logInfo "hello")
2019-07-27 19:35:30  INFO [application] Ghci1 - hello
>>> booting (pluginSimple "application") (require "user" >>= logInfo)
2019-07-27 19:37:45  INFO [application] Ghci2 - daniel

Main function

booting :: Plugin () m cxt -> AppT cxt m () -> m ()

Run application using a plugin. Context cxt can't escape from m.

Application

data AppT cxt m a

Application monad transformation.

Instances

Monad m => MonadReader cxt (AppT cxt m)

Defined in Boots.Internal.App

Methods

ask :: AppT cxt m cxt

local :: (cxt -> cxt) -> AppT cxt m a -> AppT cxt m a

reader :: (cxt -> a) -> AppT cxt m a

MonadTrans (AppT cxt)

Defined in Boots.Internal.App

Methods

lift :: Monad m => m a -> AppT cxt m a

Monad m => Monad (AppT cxt m)

Defined in Boots.Internal.App

Methods

(>>=) :: AppT cxt m a -> (a -> AppT cxt m b) -> AppT cxt m b

(>>) :: AppT cxt m a -> AppT cxt m b -> AppT cxt m b

return :: a -> AppT cxt m a

fail :: String -> AppT cxt m a

Functor m => Functor (AppT cxt m)

Defined in Boots.Internal.App

Methods

fmap :: (a -> b) -> AppT cxt m a -> AppT cxt m b

(<$) :: a -> AppT cxt m b -> AppT cxt m a

Applicative m => Applicative (AppT cxt m)

Defined in Boots.Internal.App

Methods

pure :: a -> AppT cxt m a

(<*>) :: AppT cxt m (a -> b) -> AppT cxt m a -> AppT cxt m b

liftA2 :: (a -> b -> c) -> AppT cxt m a -> AppT cxt m b -> AppT cxt m c

(*>) :: AppT cxt m a -> AppT cxt m b -> AppT cxt m b

(<*) :: AppT cxt m a -> AppT cxt m b -> AppT cxt m a

MonadIO m => MonadIO (AppT cxt m)

Defined in Boots.Internal.App

Methods

liftIO :: IO a -> AppT cxt m a

MonadUnliftIO m => MonadUnliftIO (AppT cxt m)

Defined in Boots.Internal.App

Methods

askUnliftIO :: AppT cxt m (UnliftIO (AppT cxt m))

withRunInIO :: ((forall a. AppT cxt m a -> IO a) -> IO b) -> AppT cxt m b

MonadThrow m => MonadThrow (AppT cxt m)

Defined in Boots.Internal.App

Methods

throwM :: Exception e => e -> AppT cxt m a

MonadCatch m => MonadCatch (AppT cxt m)

Defined in Boots.Internal.App

Methods

catch :: Exception e => AppT cxt m a -> (e -> AppT cxt m a) -> AppT cxt m a

MonadMask m => MonadMask (AppT cxt m)

Defined in Boots.Internal.App

Methods

mask :: ((forall a. AppT cxt m a -> AppT cxt m a) -> AppT cxt m b) -> AppT cxt m b

uninterruptibleMask :: ((forall a. AppT cxt m a -> AppT cxt m a) -> AppT cxt m b) -> AppT cxt m b

generalBracket :: AppT cxt m a -> (a -> ExitCase b -> AppT cxt m c) -> (a -> AppT cxt m b) -> AppT cxt m (b, c)

(MonadIO m, HasLogger cxt) => MonadLogger (AppT cxt m)

Defined in Boots.Plugin.Logger

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> AppT cxt m ()

(Monad m, HasSalak cxt) => MonadSalak (AppT cxt m)

Defined in Boots.Plugin.Salak

Methods

askSalak :: AppT cxt m SourcePack

askReload :: AppT cxt m (IO ReloadResult)

require :: (MonadThrow (AppT cxt m), FromProp (AppT cxt m) a) => Text -> AppT cxt m a

runAppT :: cxt -> AppT cxt m a -> m a

Run application monad transformation.

liftIO :: MonadIO m => IO a -> m a

Lift a computation from the IO monad.

ask :: MonadReader r m => m r

Retrieves the monad environment.

lift :: (MonadTrans t, Monad m) => m a -> t m a

Lift a computation from the argument monad to the constructed monad.

throwM :: (MonadThrow m, Exception e) => e -> m a

Throw an exception. Note that this throws when this action is run in the monad m, not when it is applied. It is a generalization of Control.Exception's throwIO.

Should satisfy the law:

throwM e >> f = throwM e

Application plugin

data Plugin i m u

Plugin generates component u with the context of component i running in monad m.

Instances

MonadReader i (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

ask :: Plugin i m i

local :: (i -> i) -> Plugin i m a -> Plugin i m a

reader :: (i -> a) -> Plugin i m a

MonadTrans (Plugin i)

Defined in Boots.Internal.Plugin

Methods

lift :: Monad m => m a -> Plugin i m a

Monad (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

(>>=) :: Plugin i m a -> (a -> Plugin i m b) -> Plugin i m b

(>>) :: Plugin i m a -> Plugin i m b -> Plugin i m b

return :: a -> Plugin i m a

fail :: String -> Plugin i m a

Functor (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

fmap :: (a -> b) -> Plugin i m a -> Plugin i m b

(<$) :: a -> Plugin i m b -> Plugin i m a

Applicative (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

pure :: a -> Plugin i m a

(<*>) :: Plugin i m (a -> b) -> Plugin i m a -> Plugin i m b

liftA2 :: (a -> b -> c) -> Plugin i m a -> Plugin i m b -> Plugin i m c

(*>) :: Plugin i m a -> Plugin i m b -> Plugin i m b

(<*) :: Plugin i m a -> Plugin i m b -> Plugin i m a

MonadIO m => MonadIO (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

liftIO :: IO a -> Plugin i m a

MonadThrow m => MonadThrow (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

throwM :: Exception e => e -> Plugin i m a

(MonadIO m, HasLogger cxt) => MonadLogger (Plugin cxt m)

Defined in Boots.Plugin.Logger

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> Plugin cxt m ()

Monad m => MonadCont (Plugin i m)

Defined in Boots.Internal.Plugin

Methods

callCC :: ((a -> Plugin i m b) -> Plugin i m a) -> Plugin i m a

HasSalak cxt => MonadSalak (Plugin cxt m)

Defined in Boots.Plugin.Salak

Methods

askSalak :: Plugin cxt m SourcePack

askReload :: Plugin cxt m (IO ReloadResult)

require :: (MonadThrow (Plugin cxt m), FromProp (Plugin cxt m) a) => Text -> Plugin cxt m a

runPlugin :: i -> Plugin i m u -> (u -> m ()) -> m ()

Run plugin in given context i.

promote :: i -> Plugin i m u -> Plugin x m u

Promote a plugin into another.

withPlugin :: (i -> j) -> Plugin j m u -> Plugin i m u

Convert a plugin into another.

mapPlugin :: (m () -> m ()) -> Plugin i m u -> Plugin i m u

Apply a function to transform the result of a continuation-passing computation.

bracketP

Arguments

:: MonadCatch m

=> m u

Open resource.

-> (u -> m ())

Close resource.

-> Plugin i m u

Resource plugin.

Create bracket style plugin, used for manage resources, which need to open and close.

A simple example:

>>> res = bracketP (putStrLn "open") (const $ putStrLn "close")
>>> runPlugin () res (const $ putStrLn "using")
open
using
close

module Boots.Plugin