Safe Haskell	None
Language	Haskell2010

Web.Scotty.Internal.Types

Synopsis

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 #
Methods def :: 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

Default (ScottyState e m) #
Methods def :: ScottyState e m #

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

addRoute :: 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 :: State (ScottyState e m) a

Instances

Monad (ScottyT e m) #
Methods (>>=) :: ScottyT e m a -> (a -> ScottyT e m b) -> ScottyT e m b # (>>) :: ScottyT e m a -> ScottyT e m b -> ScottyT e m b # return :: a -> ScottyT e m a # fail :: String -> ScottyT e m a #
Functor (ScottyT e m) #
Methods fmap :: (a -> b) -> ScottyT e m a -> ScottyT e m b # (<$) :: a -> ScottyT e m b -> ScottyT e m a #
Applicative (ScottyT e m) #
Methods pure :: a -> ScottyT e m a # (<>) :: ScottyT e m (a -> b) -> ScottyT e m a -> ScottyT e m b # (>) :: ScottyT e m a -> ScottyT e m b -> ScottyT e m b # (<*) :: ScottyT e m a -> ScottyT e m b -> ScottyT e m a #

data ActionError e #

Constructors

Redirect Text
Next
Finish
ActionError e

Instances

ScottyError e => ScottyError (ActionError e) #
Methods stringError :: String -> ActionError e # showError :: ActionError e -> Text #
(ScottyError e, Monad m) => MonadError (ActionError e) (ActionT e m) #
Methods throwError :: ActionError e -> ActionT e m a # catchError :: ActionT e m a -> (ActionError e -> ActionT e m a) -> ActionT e m a #

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.

Minimal complete definition

stringError, showError

Methods

stringError :: String -> e #

showError :: e -> Text #

Instances

ScottyError Text #
Methods stringError :: String -> Text # showError :: Text -> Text #
ScottyError e => ScottyError (ActionError e) #
Methods stringError :: String -> ActionError e # showError :: ActionError e -> Text #

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 :: IO ByteString getBodyChunk :: IO ByteString getFiles :: [File]

data RequestBodyState #

Constructors

BodyUntouched
BodyCached ByteString [ByteString]
BodyCorrupted

data BodyPartiallyStreamed #

Constructors

BodyPartiallyStreamed

Instances

Show BodyPartiallyStreamed #
Methods showsPrec :: Int -> BodyPartiallyStreamed -> ShowS # show :: BodyPartiallyStreamed -> String # showList :: [BodyPartiallyStreamed] -> ShowS #
Exception BodyPartiallyStreamed #
Methods toException :: BodyPartiallyStreamed -> SomeException # fromException :: SomeException -> Maybe BodyPartiallyStreamed # displayException :: BodyPartiallyStreamed -> String #

data Content #

Constructors

ContentBuilder Builder
ContentFile FilePath
ContentStream StreamingBody

data ScottyResponse #

Constructors

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

Instances

Default ScottyResponse #
Methods def :: ScottyResponse #

newtype ActionT e m a #

Constructors

ActionT
Fields runAM :: ExceptT (ActionError e) (ReaderT ActionEnv (StateT ScottyResponse m)) a

Instances

(MonadBase b m, ScottyError e) => MonadBase b (ActionT e m) #
Methods liftBase :: b α -> ActionT e m α #
(ScottyError e, MonadBaseControl b m) => MonadBaseControl b (ActionT e m) #
Associated Types type StM (ActionT e m :: * -> ) a :: # Methods liftBaseWith :: (RunInBase (ActionT e m) b -> b a) -> ActionT e m a # restoreM :: StM (ActionT e m) a -> ActionT e m a #
MonadTrans (ActionT e) #
Methods lift :: Monad m => m a -> ActionT e m a #
MonadTransControl (ActionT e) #
Associated Types type StT (ActionT e :: (* -> ) -> -> ) a :: # Methods liftWith :: Monad m => (Run (ActionT e) -> m a) -> ActionT e m a # restoreT :: Monad m => m (StT (ActionT e) a) -> ActionT e m a #
(ScottyError e, Monad m) => MonadError (ActionError e) (ActionT e m) #
Methods throwError :: ActionError e -> ActionT e m a # catchError :: ActionT e m a -> (ActionError e -> ActionT e m a) -> ActionT e m a #
(Monad m, ScottyError e) => Monad (ActionT e m) #
Methods (>>=) :: ActionT e m a -> (a -> ActionT e m b) -> ActionT e m b # (>>) :: ActionT e m a -> ActionT e m b -> ActionT e m b # return :: a -> ActionT e m a # fail :: String -> ActionT e m a #
Functor m => Functor (ActionT e m) #
Methods fmap :: (a -> b) -> ActionT e m a -> ActionT e m b # (<$) :: a -> ActionT e m b -> ActionT e m a #
(Monad m, ScottyError e) => MonadFail (ActionT e m) #
Methods fail :: String -> ActionT e m a #
Monad m => Applicative (ActionT e m) #
Methods pure :: a -> ActionT e m a # (<>) :: ActionT e m (a -> b) -> ActionT e m a -> ActionT e m b # (>) :: ActionT e m a -> ActionT e m b -> ActionT e m b # (<*) :: ActionT e m a -> ActionT e m b -> ActionT e m a #
(Monad m, ScottyError e) => Alternative (ActionT e m) #
Methods empty :: ActionT e m a # (<\|>) :: ActionT e m a -> ActionT e m a -> ActionT e m a # some :: ActionT e m a -> ActionT e m [a] # many :: ActionT e m a -> ActionT e m [a] #
(Monad m, ScottyError e) => MonadPlus (ActionT e m) #
Methods mzero :: ActionT e m a # mplus :: ActionT e m a -> ActionT e m a -> ActionT e m a #
(ScottyError e, MonadIO m) => MonadIO (ActionT e m) #
Methods liftIO :: IO a -> ActionT e m a #
type StT (ActionT e) a #
type StT (ActionT e) a = StT (StateT ScottyResponse) (StT (ReaderT * ActionEnv) (StT (ExceptT (ActionError e)) a))
type StM (ActionT e m) a #
type StM (ActionT e m) a = ComposeSt (ActionT e) m a

data RoutePattern #

Constructors

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

Instances

IsString RoutePattern #
Methods fromString :: String -> RoutePattern #