Web.Twain.Types

Documentation

data ResponderM a

ResponderM is an Either-like monad that can "short-circuit" and return a response, or pass control to the next middleware. This provides convenient branching with do notation for redirects, error responses, etc.

Constructors

ResponderM (Request -> IO (Either RouteAction (a, Request)))

Instances

MonadIO ResponderM

Defined in Web.Twain.Types

Methods

liftIO :: IO a -> ResponderM a

Applicative ResponderM

Defined in Web.Twain.Types

Methods

pure :: a -> ResponderM a

(<*>) :: ResponderM (a -> b) -> ResponderM a -> ResponderM b

liftA2 :: (a -> b -> c) -> ResponderM a -> ResponderM b -> ResponderM c

(*>) :: ResponderM a -> ResponderM b -> ResponderM b

(<*) :: ResponderM a -> ResponderM b -> ResponderM a

Functor ResponderM

Defined in Web.Twain.Types

Methods

fmap :: (a -> b) -> ResponderM a -> ResponderM b

(<$) :: a -> ResponderM b -> ResponderM a

Monad ResponderM

Defined in Web.Twain.Types

Methods

(>>=) :: ResponderM a -> (a -> ResponderM b) -> ResponderM b

(>>) :: ResponderM a -> ResponderM b -> ResponderM b

return :: a -> ResponderM a

MonadCatch ResponderM

Defined in Web.Twain.Types

Methods

catch :: (HasCallStack, Exception e) => ResponderM a -> (e -> ResponderM a) -> ResponderM a

MonadThrow ResponderM

Defined in Web.Twain.Types

Methods

throwM :: (HasCallStack, Exception e) => e -> ResponderM a

data RouteAction

Constructors

Respond Response

Next

data ParsedRequest

Constructors

ParsedRequest

Fields

• preqBody :: Maybe ParsedBody
• preqCookieParams :: [Param]
• preqPathParams :: [Param]
• preqQueryParams :: [Param]

data ResponderOptions

Constructors

ResponderOptions

Fields

• optsMaxBodySize :: Word64
• optsParseBody :: ParseRequestBodyOptions

data ParsedBody

Constructors

FormBody ([Param], [File ByteString])

JSONBody Value

data HttpError

Constructors

HttpError Status String

Instances

Exception HttpError

Defined in Web.Twain.Types

Methods

toException :: HttpError -> SomeException

fromException :: SomeException -> Maybe HttpError

displayException :: HttpError -> String

Show HttpError

Defined in Web.Twain.Types

Methods

showsPrec :: Int -> HttpError -> ShowS

show :: HttpError -> String

showList :: [HttpError] -> ShowS

Eq HttpError

Defined in Web.Twain.Types

Methods

(==) :: HttpError -> HttpError -> Bool

(/=) :: HttpError -> HttpError -> Bool

type Param = (Text, Text)

data PathPattern

Constructors

MatchPath (Request -> Maybe [Param])

Instances

IsString PathPattern

Defined in Web.Twain.Types

Methods

fromString :: String -> PathPattern

matchPath :: Text -> Request -> Maybe [Param]

class ParsableParam a where

Parse values from request parameters.

Minimal complete definition

parseParam

Methods

parseParam :: Text -> Either HttpError a

parseParamList :: Text -> Either HttpError [a]

Default implementation parses comma-delimited lists.

Instances

ParsableParam Int16

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Int16

parseParamList :: Text -> Either HttpError [Int16]

ParsableParam Int32

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Int32

parseParamList :: Text -> Either HttpError [Int32]

ParsableParam Int64

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Int64

parseParamList :: Text -> Either HttpError [Int64]

ParsableParam Int8

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Int8

parseParamList :: Text -> Either HttpError [Int8]

ParsableParam Word16

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Word16

parseParamList :: Text -> Either HttpError [Word16]

ParsableParam Word32

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Word32

parseParamList :: Text -> Either HttpError [Word32]

ParsableParam Word64

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Word64

parseParamList :: Text -> Either HttpError [Word64]

ParsableParam Word8

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Word8

parseParamList :: Text -> Either HttpError [Word8]

ParsableParam ByteString

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError ByteString

parseParamList :: Text -> Either HttpError [ByteString]

ParsableParam ByteString

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError ByteString

parseParamList :: Text -> Either HttpError [ByteString]

ParsableParam Text

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Text

parseParamList :: Text -> Either HttpError [Text]

ParsableParam Text

Defined in Web.Twain.Types

Methods

parseParam :: Text0 -> Either HttpError Text

parseParamList :: Text0 -> Either HttpError [Text]

ParsableParam Integer

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Integer

parseParamList :: Text -> Either HttpError [Integer]

ParsableParam Natural

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Natural

parseParamList :: Text -> Either HttpError [Natural]

ParsableParam ()

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError ()

parseParamList :: Text -> Either HttpError [()]

ParsableParam Bool

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Bool

parseParamList :: Text -> Either HttpError [Bool]

ParsableParam Char

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Char

parseParamList :: Text -> Either HttpError [Char]

ParsableParam Double

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Double

parseParamList :: Text -> Either HttpError [Double]

ParsableParam Float

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Float

parseParamList :: Text -> Either HttpError [Float]

ParsableParam Int

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Int

parseParamList :: Text -> Either HttpError [Int]

ParsableParam Word

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError Word

parseParamList :: Text -> Either HttpError [Word]

ParsableParam a => ParsableParam [a]

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either HttpError [a]

parseParamList :: Text -> Either HttpError [[a]]

readEither :: Read a => Text -> Either HttpError a

Useful for creating ParsableParam instances for things that already implement Read.

data HTTP2Exception

Constructors

HTTP2Exception ErrorCode

Instances

Exception HTTP2Exception

Defined in Web.Twain.Types

Methods

toException :: HTTP2Exception -> SomeException

fromException :: SomeException -> Maybe HTTP2Exception

displayException :: HTTP2Exception -> String

Show HTTP2Exception

Defined in Web.Twain.Types

Methods

showsPrec :: Int -> HTTP2Exception -> ShowS

show :: HTTP2Exception -> String

showList :: [HTTP2Exception] -> ShowS