WebGear.Route

Types and functions to route HTTP requests.

Documentation

type RouterT m = ExceptT (Maybe (First (Response ByteString))) m

The monad transformer stack for routing.

• The ExceptT provides short-circuiting behaviour for rejectRoute and failHandler.
• In case of rejectRoute, a Nothing value is returned and in case of failHandler, a Response ByteString is returned.
• The First wrapper is provided to get instances of Alternative and MonadPlus for RouterT.

class (Alternative m, MonadPlus m) => MonadRouter m where

HTTP request routing with short circuiting behavior.

Methods

rejectRoute :: m a

Mark the current route as rejected, alternatives can be tried

failHandler :: Response ByteString -> m a

Short-circuit the current handler and return a response

Instances

Monad m => MonadRouter (RouterT m)

Defined in WebGear.Route

Methods

rejectRoute :: RouterT m a

failHandler :: Response ByteString -> RouterT m a

runRoute :: Monad m => Handler (RouterT m) '[] res ByteString -> Request -> m Response

Convert a routable handler into a plain function.

This function is typically used to convert WebGear routes to a Application.