Boots.Plugin

Boot plugin.

Documentation

boot :: Monad m => Plugin () m (m ()) -> m ()

Run application only in 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 ()

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

Defined in Boots.Plugin.Logger

Methods

askLoggerIO :: Plugin cxt m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())

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.

combine :: [Plugin i m i] -> Plugin i m i

Combines plugins into one.

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.

isoPlugin :: (m () -> n ()) -> (n () -> m ()) -> Plugin i n u -> Plugin i m u

Transform a plugin with monad n to a plugin with monad m.

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

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

Warp plugin.