Safe Haskell	None
Language	Haskell2010

Web.Scotty.Internal.Types

Synopsis

Documentation

data Options Source

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 Source

type Application m = Request -> m Response Source

data ScottyState e m Source

Constructors

ScottyState
Fields middlewares :: [Middleware] routes :: [Middleware m] handler :: ErrorHandler e m

Instances

Default (ScottyState e m)

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

addRoute :: Middleware m -> ScottyState e m -> ScottyState e m Source

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

newtype ScottyT e m a Source

Constructors

ScottyT
Fields runS :: State (ScottyState e m) a

Instances

Monad (ScottyT e m)
Functor (ScottyT e m)
Applicative (ScottyT e m)

data ActionError e Source

Constructors

Redirect Text
Next
ActionError e

Instances

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

class ScottyError e where Source

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 Source

showError :: e -> Text Source

Instances

ScottyError Text
ScottyError e => ScottyError (ActionError e)

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

type Param = (Text, Text) Source

type File = (Text, FileInfo ByteString) Source

data ActionEnv Source

Constructors

Env
Fields getReq :: Request getParams :: [Param] getBody :: IO ByteString getBodyChunk :: IO ByteString getFiles :: [File]

data RequestBodyState Source

Constructors

BodyUntouched
BodyCached ByteString [ByteString]
BodyCorrupted

data BodyPartiallyStreamed Source

Constructors

BodyPartiallyStreamed

Instances

Show BodyPartiallyStreamed
Exception BodyPartiallyStreamed
Typeable * BodyPartiallyStreamed

data Content Source

Constructors

ContentBuilder Builder
ContentFile FilePath
ContentStream StreamingBody

data ScottyResponse Source

Constructors

SR
Fields srStatus :: Status srHeaders :: ResponseHeaders srContent :: Content

Instances

Default ScottyResponse

newtype ActionT e m a Source

Constructors

ActionT
Fields runAM :: ExceptT (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)
MonadTrans (ActionT e)
MonadTransControl (ActionT e)
(ScottyError e, Monad m) => MonadError (ActionError e) (ActionT e m)
(Monad m, ScottyError e, Functor m) => Alternative (ActionT e m)
(Monad m, ScottyError e) => Monad (ActionT e m)
Functor m => Functor (ActionT e m)
(Monad m, ScottyError e) => MonadPlus (ActionT e m)
(Monad m, Functor m) => Applicative (ActionT e m)
(MonadIO m, ScottyError e) => MonadIO (ActionT e m)
type StT (ActionT e) a = StT (StateT ScottyResponse) (StT (ReaderT ActionEnv) (StT (ExceptT (ActionError e)) a))
type StM (ActionT e m) a = ComposeSt (ActionT e) m a

data RoutePattern Source

Constructors

Capture Text
Literal Text
Function (Request -> Maybe [Param])

Instances

IsString RoutePattern