Webby

Documentation

data WebbyM appEnv a

The main monad transformer stack used in the web-framework.

The type of a handler for a request is `WebbyM appEnv ()`. The appEnv parameter is used by the web application to store an (read-only) environment. For e.g. it can be used to store a database connection pool.

Instances

Monad (WebbyM appEnv)

Defined in Webby.Types

Methods

(>>=) :: WebbyM appEnv a -> (a -> WebbyM appEnv b) -> WebbyM appEnv b

(>>) :: WebbyM appEnv a -> WebbyM appEnv b -> WebbyM appEnv b

return :: a -> WebbyM appEnv a

fail :: String -> WebbyM appEnv a

Functor (WebbyM appEnv)

Defined in Webby.Types

Methods

fmap :: (a -> b) -> WebbyM appEnv a -> WebbyM appEnv b

(<$) :: a -> WebbyM appEnv b -> WebbyM appEnv a

Applicative (WebbyM appEnv)

Defined in Webby.Types

Methods

pure :: a -> WebbyM appEnv a

(<*>) :: WebbyM appEnv (a -> b) -> WebbyM appEnv a -> WebbyM appEnv b

liftA2 :: (a -> b -> c) -> WebbyM appEnv a -> WebbyM appEnv b -> WebbyM appEnv c

(*>) :: WebbyM appEnv a -> WebbyM appEnv b -> WebbyM appEnv b

(<*) :: WebbyM appEnv a -> WebbyM appEnv b -> WebbyM appEnv a

MonadIO (WebbyM appEnv)

Defined in Webby.Types

Methods

liftIO :: IO a -> WebbyM appEnv a

MonadUnliftIO (WebbyM appData)

Defined in Webby.Types

Methods

askUnliftIO :: WebbyM appData (UnliftIO (WebbyM appData))

withRunInIO :: ((forall a. WebbyM appData a -> IO a) -> IO b) -> WebbyM appData b

MonadLogger (WebbyM env)

Defined in Webby.Types

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> WebbyM env ()

MonadReader (WEnv appEnv) (WebbyM appEnv)

Defined in Webby.Types

Methods

ask :: WebbyM appEnv (WEnv appEnv)

local :: (WEnv appEnv -> WEnv appEnv) -> WebbyM appEnv a -> WebbyM appEnv a

reader :: (WEnv appEnv -> a) -> WebbyM appEnv a

Routing and handler functions

data RoutePattern

Instances

Eq RoutePattern

Defined in Webby.Types

Methods

(==) :: RoutePattern -> RoutePattern -> Bool

(/=) :: RoutePattern -> RoutePattern -> Bool

Show RoutePattern

Defined in Webby.Types

Methods

showsPrec :: Int -> RoutePattern -> ShowS

show :: RoutePattern -> String

showList :: [RoutePattern] -> ShowS

type Routes appEnv = [(RoutePattern, WebbyM appEnv ())]

The Routes of a web-application are a list of mappings from a RoutePattern to a handler function.

mkRoute :: Method -> Text -> WebbyM appEnv () -> (RoutePattern, WebbyM appEnv ())

Create a route for a user-provided HTTP request method, pattern and handler function.

post :: Text -> WebbyM appEnv () -> (RoutePattern, WebbyM appEnv ())

Create a route for a POST request method, given the path pattern and handler.

get :: Text -> WebbyM appEnv () -> (RoutePattern, WebbyM appEnv ())

Create a route for a GET request method, given the path pattern and handler.

put :: Text -> WebbyM appEnv () -> (RoutePattern, WebbyM appEnv ())

Create a route for a PUT request method, given the path pattern and handler.

Captures

type Captures = HashMap Text Text

Captures are simply extracted path elements in a HashMap

captures :: WebbyM appEnv Captures

Retrieve all path captures

getCapture :: FromHttpApiData a => Text -> WebbyM appEnv a

Retrieve a particular capture (TODO: extend?)

Request parsing

flag :: Text -> WebbyM appEnv Bool

header :: HeaderName -> WebbyM appEnv (Maybe Text)

headers :: WebbyM appEnv [Header]

jsonData :: FromJSON a => WebbyM appEnv a

param :: FromHttpApiData a => Text -> WebbyM appEnv (Maybe a)

param_ :: FromHttpApiData a => Text -> WebbyM appEnv a

params :: WebbyM appEnv [(Text, Text)]

request :: WebbyM appEnv Request

requestBodyLength :: WebbyM appEnv (Maybe Int64)

Response modification

setStatus :: Status -> WebbyM appEnv ()

addHeader :: Header -> WebbyM appEnv ()

setHeader :: Header -> WebbyM appEnv ()

blob :: ByteString -> WebbyM appEnv ()

json :: ToJSON b => b -> WebbyM appEnv ()

text :: Text -> WebbyM appEnv ()

stream :: StreamingBody -> WebbyM appEnv ()

Application

mkWebbyApp :: appEnv -> Routes appEnv -> IO Application

Use this function, to create a WAI application. It takes a user/application defined appEnv data type and a list of routes. If none of the requests match a request, a default 404 response is returned.

Application context

data WEnv appEnv

The reader environment used by the web framework. It is parameterized by the application's environment data type.

Instances

MonadReader (WEnv appEnv) (WebbyM appEnv)

Defined in Webby.Types

Methods

ask :: WebbyM appEnv (WEnv appEnv)

local :: (WEnv appEnv -> WEnv appEnv) -> WebbyM appEnv a -> WebbyM appEnv a

reader :: (WEnv appEnv -> a) -> WebbyM appEnv a

getAppEnv :: WebbyM appEnv appEnv

Retrieve the app environment given to the application at initialization.

runAppEnv :: ReaderT appEnv (WebbyM appEnv) a -> WebbyM appEnv a

Handler flow control

finish :: WebbyM appEnv a

Exceptions thrown

data WebbyError

Various kinds of errors thrown by this library - these can be caught by handler code.

Constructors

WebbyJSONParseError Text

WebbyParamParseError

Fields

• wppeParamName :: Text
• wppeErrMsg :: Text

WebbyMissingCapture Text

Instances

Show WebbyError

Defined in Webby.Types

Methods

showsPrec :: Int -> WebbyError -> ShowS

show :: WebbyError -> String

showList :: [WebbyError] -> ShowS

Exception WebbyError

Defined in Webby.Types

Methods

toException :: WebbyError -> SomeException

fromException :: SomeException -> Maybe WebbyError

displayException :: WebbyError -> String