Web.Scotty.Internal.Types

Documentation

data Options

Constructors

Options

Fields

verbose :: Int

0 = silent, 1(def) = startup banner

settings :: Settings

Warp Settings Note: to work around an issue in warp, the default FD cache duration is set to 0 so changes to static files are always picked up. This likely has performance implications, so you may want to modify this for production servers using setFdCacheDuration.

Instances

Default Options

type Middleware m = Application m -> Application m

type Application m = Request -> m Response

data ScottyState e m

Constructors

ScottyState

Fields

middlewares :: [Middleware]

routes :: [Middleware m]

handler :: ErrorHandler e m

Instances

Monad m => Default (ScottyState e m)

addMiddleware :: Middleware -> ScottyState e m -> ScottyState e m

addRoute :: Monad m => Middleware m -> ScottyState e m -> ScottyState e m

addHandler :: ErrorHandler e m -> ScottyState e m -> ScottyState e m

newtype ScottyT e m a

Constructors

ScottyT

Fields

runS :: StateT (ScottyState e m) m a

Instances

MonadTrans (ScottyT e)

Monad m => Monad (ScottyT e m)

Functor m => Functor (ScottyT e m)

(Monad m, Functor m) => Applicative (ScottyT e m)

MonadIO m => MonadIO (ScottyT e m)

data ActionError e

Constructors

Redirect Text

Next

ActionError e

Instances

ScottyError e => Error (ActionError e)

ScottyError e => ScottyError (ActionError e)

(ScottyError e, Monad m) => MonadError (ActionError e) (ActionT e m)

class ScottyError e where

In order to use a custom exception type (aside from Text), you must define an instance of ScottyError for that type.

Methods

stringError :: String -> e

showError :: e -> Text

Instances

ScottyError Text

ScottyError e => ScottyError (ActionError e)

type ErrorHandler e m = Maybe (e -> ActionT e m ())

type Param = (Text, Text)

type File = (Text, FileInfo ByteString)

data ActionEnv

Constructors

Env

Fields

getReq :: Request

getParams :: [Param]

getBody :: ByteString

getFiles :: [File]

data Content

Constructors

ContentBuilder Builder

ContentFile FilePath

ContentStream StreamingBody

data ScottyResponse

Constructors

SR

Fields

srStatus :: Status

srHeaders :: ResponseHeaders

srContent :: Content

Instances

Default ScottyResponse

newtype ActionT e m a

Constructors

ActionT

Fields

runAM :: ErrorT (ActionError e) (ReaderT ActionEnv (StateT ScottyResponse m)) a

Instances

(MonadBase b m, ScottyError e) => MonadBase b (ActionT e m)

(ScottyError e, MonadBaseControl b m) => MonadBaseControl b (ActionT e m)

ScottyError e => MonadTrans (ActionT e)

ScottyError e => MonadTransControl (ActionT e)

(ScottyError e, Monad m) => MonadError (ActionError e) (ActionT e m)

(Monad m, ScottyError e) => Monad (ActionT e m)

Functor m => Functor (ActionT e m)

(Monad m, Functor m) => Applicative (ActionT e m)

(MonadIO m, ScottyError e) => MonadIO (ActionT e m)

data RoutePattern

Constructors

Capture Text

Literal Text

Function (Request -> Maybe [Param])

Instances

IsString RoutePattern