Web.Wheb.WhebT

ReaderT and StateT Functionality

ReaderT

getApp :: Monad m => WhebT g s m g

Get the g in WhebT g s m g. This is a read-only state so only thread-safe resources such as DB connections should go in here.

getWithApp :: Monad m => (g -> a) -> WhebT g s m a

StateT

getHandlerState :: Monad m => WhebT g s m s

Get the s in WhebT g s m g. This is a read and writable state so you can get and put information in your state. Each request gets its own fresh state duplicated from our options startingState

putHandlerState :: Monad m => s -> WhebT g s m ()

modifyHandlerState :: Monad m => (s -> s) -> WhebT g s m s

modifyHandlerState' :: Monad m => (s -> s) -> WhebT g s m ()

Responses

setHeader :: Monad m => Text -> Text -> WhebT g s m ()

Set a header for the response

setRawHeader :: Monad m => Header -> WhebT g s m ()

Set a Strict ByteString header for the response

html :: Monad m => Text -> WhebHandlerT g s m

Return simple HTML from Text

text :: Monad m => Text -> WhebHandlerT g s m

Return simple Text

file :: Monad m => Text -> Text -> WhebHandlerT g s m

Give filepath and content type to serve a file from disk.

builder :: Monad m => Text -> Builder -> WhebHandlerT g s m

Give content type and Blaze Builder

redirect :: Monad m => Text -> WhebHandlerT g s m

Redirect to a given URL

Settings

getSetting :: Monad m => Text -> WhebT g s m (Maybe Text)

Help prevent monomorphism errors for simple settings.

getSetting' :: (Monad m, Typeable a) => Text -> WhebT g s m (Maybe a)

Open up underlying support for polymorphic global settings

getSetting'' :: (Monad m, Typeable a) => Text -> a -> WhebT g s m a

Get a setting or a default

getSettings :: Monad m => WhebT g s m CSettings

Get all settings.

Routes

getRouteParams :: Monad m => WhebT g s m RouteParamList

Get all route params.

getRouteParam :: (Typeable a, Monad m) => Text -> WhebT g s m a

Cast a route param into its type.

getRoute :: Monad m => Text -> RouteParamList -> WhebT g s m Text

Convert Either from getRoute' into an error in the Monad

getRoute' :: Monad m => Text -> RouteParamList -> WhebT g s m (Either UrlBuildError Text)

Generate a route from a name and param list.

getRawRoute :: Monad m => Text -> RouteParamList -> WhebT g s m (Maybe (Route g s m))

Generate the raw route

Request reading

getRequest :: Monad m => WhebT g s m Request

Access the request

getRequestHeader :: Monad m => Text -> WhebT g s m (Maybe Text)

Get a request header

getWithRequest :: Monad m => (Request -> a) -> WhebT g s m a

getQueryParams :: Monad m => WhebT g s m Query

Get params from URL (e.g. from '/foo/?q=4')

getPOSTParam :: MonadIO m => Text -> WhebT g s m (Maybe Text)

Maybe get one param if it exists.

getPOSTParams :: MonadIO m => WhebT g s m [(Text, Text)]

Get POST params as Text

getRawPOST :: MonadIO m => WhebT g s m ([Param], [File ByteString])

Get the raw parsed POST data including files.

Running Wheb

runWhebServer :: WhebOptions g s IO -> IO ()

Convenience wrapper for runWhebServerT function in IO

runWhebServerT :: (forall a. m a -> IO a) -> WhebOptions g s m -> IO ()

Run a server with a function to run your inner Transformer to IO and generated options

runRawHandler :: WhebOptions g s IO -> WhebT g s IO a -> IO (Either WhebError a)

Convenience wrapper for runRawHandlerT function in IO

runRawHandlerT :: WhebOptions g s m -> (m (Either WhebError a) -> IO (Either WhebError a)) -> Request -> WhebT g s m a -> IO (Either WhebError a)

Running a Handler with a custom Transformer