Magicbane.App

Extends Servant with context. Basically wrapping Servant in a ReaderT of your type. Which should be a tuple of all your moudles and configs and stuff, so that the Data.Has module would let you access these items by type.

Documentation

newtype MagicbaneApp β α

Constructors

MagicbaneApp

Fields

• unMagicbaneApp :: ReaderT β (ExceptT ServantErr IO) α

Instances

MonadReader β (MagicbaneApp β)

Methods

ask :: MagicbaneApp β β

local :: (β -> β) -> MagicbaneApp β a -> MagicbaneApp β a

reader :: (β -> a) -> MagicbaneApp β a

MonadBaseControl IO (MagicbaneApp β)

Associated Types

type StM (MagicbaneApp β :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase (MagicbaneApp β) IO -> IO a) -> MagicbaneApp β a

restoreM :: StM (MagicbaneApp β) a -> MagicbaneApp β a

MonadBase IO (MagicbaneApp β)

Methods

liftBase :: IO α -> MagicbaneApp β α

MonadError ServantErr (MagicbaneApp β)

Methods

throwError :: ServantErr -> MagicbaneApp β a

catchError :: MagicbaneApp β a -> (ServantErr -> MagicbaneApp β a) -> MagicbaneApp β a

Monad (MagicbaneApp β)

Methods

(>>=) :: MagicbaneApp β a -> (a -> MagicbaneApp β b) -> MagicbaneApp β b

(>>) :: MagicbaneApp β a -> MagicbaneApp β b -> MagicbaneApp β b

return :: a -> MagicbaneApp β a

fail :: String -> MagicbaneApp β a

Functor (MagicbaneApp β)

Methods

fmap :: (a -> b) -> MagicbaneApp β a -> MagicbaneApp β b

(<$) :: a -> MagicbaneApp β b -> MagicbaneApp β a

Applicative (MagicbaneApp β)

Methods

pure :: a -> MagicbaneApp β a

(<*>) :: MagicbaneApp β (a -> b) -> MagicbaneApp β a -> MagicbaneApp β b

(*>) :: MagicbaneApp β a -> MagicbaneApp β b -> MagicbaneApp β b

(<*) :: MagicbaneApp β a -> MagicbaneApp β b -> MagicbaneApp β a

MonadIO (MagicbaneApp β)

Methods

liftIO :: IO a -> MagicbaneApp β a

MonadCatch (MagicbaneApp β)

Methods

catch :: Exception e => MagicbaneApp β a -> (e -> MagicbaneApp β a) -> MagicbaneApp β a

MonadThrow (MagicbaneApp β)

Methods

throwM :: Exception e => e -> MagicbaneApp β a

type StM (MagicbaneApp β) α

type StM (MagicbaneApp β) α = StM (ReaderT * β (ExceptT ServantErr IO)) α

runMagicbaneExcept :: β -> MagicbaneApp β α -> ExceptT ServantErr IO α

magicbaneToExcept :: β -> MagicbaneApp β :~> ExceptT ServantErr IO

magicbaneApp :: (HasServer * api context, Enter typ ((:~>) * (MagicbaneApp β) (ExceptT ServantErr IO)) (ServerT * api Handler)) => Proxy * api -> Context context -> β -> typ -> Application

Constructs a WAI application from an API definition, a Servant context (used for auth mainly), the app context and the actual action handlers.

askObj :: (Has β α, MonadReader α μ) => μ β

Gets a value of any type from the context.

askOpt :: (Has β α, MonadReader α μ) => (β -> ψ) -> μ ψ

Gets a thing from a value of any type from the context. (Useful for configuration fields.)