Modulescotty-0.22Haskell2010

Web.Scotty.Internal.Types

21 types
18 values

Packagescotty-0.22
Exports39
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

datadata Options

Constructors

Options
- 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.

Instances1Default

Default OptionsDefined in scotty-0.22 · Web.Scotty.Internal.Types

valuedefaultOptions :: Options

newtypenewtype RouteOptions

Constructors

RouteOptions
- maxRequestBodySize :: Maybe Kilobytes

Instances1Default

Default RouteOptionsDefined in scotty-0.22 · Web.Scotty.Internal.Types

valuedefaultRouteOptions :: RouteOptions

typetype Kilobytes = Int

typetype Middleware (m :: Type -> Type) = Application m -> Application m

typetype Application (m :: Type -> Type) = Request -> m Response

datadata BodyChunkBuffer

Constructors

BodyChunkBuffer
- hasFinishedReadingChunks :: Bool
  whether we've reached the end of the stream yet
- chunksReadSoFar :: [ByteString]

datadata BodyInfo

The key part of having two MVars is that we can "clone" the BodyInfo to create a copy where the index is reset to 0, but the chunk cache is the same. Passing a cloned BodyInfo into each matched route allows them each to start from the first chunk if they call bodyReader.

Introduced in (#308)

Constructors

BodyInfo
- bodyInfoReadProgress :: MVar Int
  index into the stream read so far
- bodyInfoChunkBuffer :: MVar BodyChunkBuffer
- bodyInfoDirectChunkRead :: IO ByteString
  can be called to get more chunks

datadata ScottyState (m :: Type -> Type)

Constructors

ScottyState
- middlewares :: [Middleware]
- routes :: [BodyInfo -> Middleware m]
- handler :: Maybe (ErrorHandler m)
- routeOptions :: RouteOptions

valuedefaultScottyState :: ScottyState m

valueaddMiddleware :: Middleware -> ScottyState m -> ScottyState m

valueaddRoute :: (BodyInfo -> Middleware m) -> ScottyState m -> ScottyState m

valuesetHandler :: Maybe (ErrorHandler m) -> ScottyState m -> ScottyState m

valueupdateMaxRequestBodySize :: RouteOptions -> ScottyState m -> ScottyState m

newtypenewtype ScottyT (m :: Type -> Type) a

Constructors

ScottyT
- runS :: ReaderT Options (State (ScottyState m)) a

Instances5Monad, Functor, Applicative, Semigroup, Monoid

Monad (ScottyT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Functor (ScottyT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Applicative (ScottyT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Semigroup a => Semigroup (ScottyT m a)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Monoid a => Monoid (ScottyT m a)Defined in scotty-0.22 · Web.Scotty.Internal.Types

datadata ActionError

Internal exception mechanism used to modify the request processing flow.

The exception constructor is not exposed to the user and all exceptions of this type are caught and processed within the runAction function.

Constructors

AERedirect Text
Redirect
AENext
Stop processing this route and skip to the next one
AEFinish
Stop processing the request

Instances2Show, Exception

Show ActionErrorDefined in scotty-0.22 · Web.Scotty.Internal.Types
Exception ActionErrorDefined in scotty-0.22 · Web.Scotty.Internal.Types

valuetryNext :: MonadUnliftIO m => m a -> m Bool

datadata StatusError

Deprecated. If it is supposed to be caught, a proper exception type should be defined

E.g. when a parameter is not found in a query string (400 Bad Request) or when parsing a JSON body fails (422 Unprocessable Entity)

Constructors

StatusError Status Text

Instances3Show, Exception, MonadError

Show StatusErrorDefined in scotty-0.22 · Web.Scotty.Internal.Types
Exception StatusErrorDefined in scotty-0.22 · Web.Scotty.Internal.Types
MonadUnliftIO m => MonadError StatusError (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Models the invariant that only StatusErrors can be thrown and caught.

typetype ErrorHandler (m :: Type -> Type) = Handler (ActionT m) ()

Specializes a Handler to the ActionT monad

datadata ScottyException

Thrown e.g. when a request is too large

Instances2Show, Exception

Show ScottyExceptionDefined in scotty-0.22 · Web.Scotty.Internal.Types
Exception ScottyExceptionDefined in scotty-0.22 · Web.Scotty.Internal.Types

typetype Param = (Text, Text)

typetype File t = (Text, FileInfo t)

Type parameter t is the file content. Could be () when not needed or a FilePath for temp files instead.

datadata ActionEnv

Constructors

Env
- envReq :: Request
- envPathParams :: [Param]
- envQueryParams :: [Param]
- envFormDataAction :: InternalState -> ParseRequestBodyOptions -> IO ([Param], [File FilePath])
- envBody :: IO ByteString
- envBodyChunk :: IO ByteString
- envResponse :: TVar ScottyResponse

valueformParamsAndFilesWith

:: MonadUnliftIO m
=> InternalState
-> ParseRequestBodyOptions
-> ActionT m ([Param], [File FilePath])

valuegetResponse :: MonadIO m => ActionEnv -> m ScottyResponse

valuegetResponseAction :: MonadIO m => ActionT m ScottyResponse

valuemodifyResponse

:: MonadIO m
=> ScottyResponse -> ScottyResponse
-> ActionT m ()

datadata BodyPartiallyStreamed

BodyPartiallyStreamed

Instances2Show, Exception

Show BodyPartiallyStreamedDefined in scotty-0.22 · Web.Scotty.Internal.Types
Exception BodyPartiallyStreamedDefined in scotty-0.22 · Web.Scotty.Internal.Types

datadata Content

Constructors

datadata ScottyResponse

Constructors

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

Instances1Default

Default ScottyResponseDefined in scotty-0.22 · Web.Scotty.Internal.Types

valuesetContent :: Content -> ScottyResponse -> ScottyResponse

valuesetHeaderWith

:: [(HeaderName, ByteString)] -> [(HeaderName, ByteString)]
-> ScottyResponse
-> ScottyResponse

valuesetStatus :: Status -> ScottyResponse -> ScottyResponse

valuedefaultScottyResponse :: ScottyResponse

The default response has code 200 OK and empty body

newtypenewtype ActionT (m :: Type -> Type) a

Constructors

ActionT
- runAM :: ReaderT ActionEnv m a

Instances20MonadTrans, MonadTransControl, MonadError, MonadReader, MonadBase, MonadBaseControl, …

MonadTrans ActionTDefined in scotty-0.22 · Web.Scotty.Internal.Types
MonadTransControl ActionTDefined in scotty-0.22 · Web.Scotty.Internal.Types
MonadUnliftIO m => MonadError StatusError (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Models the invariant that only StatusErrors can be thrown and caught.
MonadReader r m => MonadReader r (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadBase b m => MonadBase b (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadBaseControl b m => MonadBaseControl b (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Monad m => Monad (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Functor m => Functor (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadIO m => MonadFail (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
Modeled after the behaviour in scotty < 0.20, fail throws a StatusError with code 500 ("Server Error"), which can be caught with catch.
Applicative m => Applicative (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadUnliftIO m => Alternative (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
empty throws ActionError AENext, whereas (<|>) catches any ActionErrors or StatusErrors in the first action and proceeds to the second one.
MonadUnliftIO m => MonadPlus (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadIO m => MonadIO (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadCatch m => MonadCatch (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadThrow m => MonadThrow (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
MonadUnliftIO m => MonadUnliftIO (ActionT m)Defined in scotty-0.22 · Web.Scotty.Internal.Types
(Monad m, Semigroup a) => Semigroup (ActionT m a)Defined in scotty-0.22 · Web.Scotty.Internal.Types
(Monad m, Monoid a) => Monoid (ActionT m a)Defined in scotty-0.22 · Web.Scotty.Internal.Types
type StM (ActionT m) a = StM (ReaderT ActionEnv m) aDefined in scotty-0.22 · Web.Scotty.Internal.Types
type StT ActionT a = StT (ReaderT ActionEnv) aDefined in scotty-0.22 · Web.Scotty.Internal.Types

valuewithActionEnv

:: Monad m
=> ActionEnv -> ActionEnv
-> ActionT m a
-> ActionT m a

valuetryAnyStatus :: MonadUnliftIO m => m a -> m Bool

catches either ActionError (thrown by next), ScottyException (thrown if e.g. a query parameter is not found) or StatusError (via raiseStatus)

datadata RoutePattern

Constructors

Instances1IsString

IsString RoutePatternDefined in scotty-0.22 · Web.Scotty.Internal.Types