Web.Scotty.Internal.Types

Synopsis

• data Options = Options {
  • verbose :: Int
  • settings :: Settings
  }
• type Middleware m = Application m -> Application m
• type Application m = Request -> m Response
• data ScottyState e m = ScottyState {
  • middlewares :: [Middleware]
  • routes :: [Middleware m]
  • handler :: ErrorHandler 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 = ScottyT {
  • runS :: State (ScottyState e m) a
  }
• data ActionError e
  • = Redirect Text
  • | Next
  • | ActionError e
• class ScottyError e where
  • stringError :: String -> e
  • showError :: e -> Text
• type ErrorHandler e m = Maybe (e -> ActionT e m ())
• type Param = (Text, Text)
• type File = (Text, FileInfo ByteString)
• data ActionEnv = Env {
  • getReq :: Request
  • getParams :: [Param]
  • getBody :: IO ByteString
  • getBodyChunk :: IO ByteString
  • getFiles :: [File]
  }
• data RequestBodyState
  • = BodyUntouched
  • | BodyCached ByteString [ByteString]
  • | BodyCorrupted
• data BodyPartiallyStreamed = BodyPartiallyStreamed
• data Content
  • = ContentBuilder Builder
  • | ContentFile FilePath
  • | ContentStream StreamingBody
• data ScottyResponse = SR {
  • srStatus :: Status
  • srHeaders :: ResponseHeaders
  • srContent :: Content
  }
• newtype ActionT e m a = ActionT {
  • runAM :: ExceptT (ActionError e) (ReaderT ActionEnv (StateT ScottyResponse m)) a
  }
• data RoutePattern
  • = Capture Text
  • | Literal Text
  • | Function (Request -> Maybe [Param])

Documentation