Web.Twain.Types

Documentation

newtype TwainM e a

TwainM provides a monad interface for composing routes and middleware.

Constructors

TwainM (TwainState e -> (a, TwainState e))

Instances

Monad (TwainM e)

Defined in Web.Twain.Types

Methods

(>>=) :: TwainM e a -> (a -> TwainM e b) -> TwainM e b

(>>) :: TwainM e a -> TwainM e b -> TwainM e b

return :: a -> TwainM e a

Functor (TwainM e)

Defined in Web.Twain.Types

Methods

fmap :: (a -> b) -> TwainM e a -> TwainM e b

(<$) :: a -> TwainM e b -> TwainM e a

Applicative (TwainM e)

Defined in Web.Twain.Types

Methods

pure :: a -> TwainM e a

(<*>) :: TwainM e (a -> b) -> TwainM e a -> TwainM e b

liftA2 :: (a -> b -> c) -> TwainM e a -> TwainM e b -> TwainM e c

(*>) :: TwainM e a -> TwainM e b -> TwainM e b

(<*) :: TwainM e a -> TwainM e b -> TwainM e a

data TwainState e

Constructors

TwainState

Fields

• middlewares :: [Middleware]
• environment :: e
• onExceptionResponse :: SomeException -> Response

modify :: (TwainState e -> TwainState e) -> TwainM e ()

exec :: TwainM e a -> e -> TwainState e

data RouteM e a

RouteM is a Reader-like monad that can "short-circuit" and return a WAI response using a given environment. This provides convenient branching with do notation for redirects, error responses, etc.

Constructors

RouteM (RouteState e -> IO (Either RouteAction (a, RouteState e)))

Instances

Monad (RouteM e)

Defined in Web.Twain.Types

Methods

(>>=) :: RouteM e a -> (a -> RouteM e b) -> RouteM e b

(>>) :: RouteM e a -> RouteM e b -> RouteM e b

return :: a -> RouteM e a

Functor (RouteM e)

Defined in Web.Twain.Types

Methods

fmap :: (a -> b) -> RouteM e a -> RouteM e b

(<$) :: a -> RouteM e b -> RouteM e a

Applicative (RouteM e)

Defined in Web.Twain.Types

Methods

pure :: a -> RouteM e a

(<*>) :: RouteM e (a -> b) -> RouteM e a -> RouteM e b

liftA2 :: (a -> b -> c) -> RouteM e a -> RouteM e b -> RouteM e c

(*>) :: RouteM e a -> RouteM e b -> RouteM e b

(<*) :: RouteM e a -> RouteM e b -> RouteM e a

MonadIO (RouteM e)

Defined in Web.Twain.Types

Methods

liftIO :: IO a -> RouteM e a

data RouteAction

Constructors

Respond Response

Next

data RouteState e

Constructors

RouteState

Fields

• reqBodyParams :: [Param]
• reqBodyFiles :: [File ByteString]
• reqPathParams :: [Param]
• reqQueryParams :: [Param]
• reqCookieParams :: [Param]
• reqBodyJson :: Either String Value
• reqBodyParsed :: Bool
• reqEnv :: e
• reqWai :: Request

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 Text a

parseParamList :: Text -> Either Text [a]

Default implementation parses comma-delimited lists.

Instances

ParsableParam Bool

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Bool

parseParamList :: Text -> Either Text [Bool]

ParsableParam Char

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Char

parseParamList :: Text -> Either Text [Char]

ParsableParam Double

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Double

parseParamList :: Text -> Either Text [Double]

ParsableParam Float

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Float

parseParamList :: Text -> Either Text [Float]

ParsableParam Int

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Int

parseParamList :: Text -> Either Text [Int]

ParsableParam Int8

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Int8

parseParamList :: Text -> Either Text [Int8]

ParsableParam Int16

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Int16

parseParamList :: Text -> Either Text [Int16]

ParsableParam Int32

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Int32

parseParamList :: Text -> Either Text [Int32]

ParsableParam Int64

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Int64

parseParamList :: Text -> Either Text [Int64]

ParsableParam Integer

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Integer

parseParamList :: Text -> Either Text [Integer]

ParsableParam Natural

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Natural

parseParamList :: Text -> Either Text [Natural]

ParsableParam Word

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Word

parseParamList :: Text -> Either Text [Word]

ParsableParam Word8

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Word8

parseParamList :: Text -> Either Text [Word8]

ParsableParam Word16

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Word16

parseParamList :: Text -> Either Text [Word16]

ParsableParam Word32

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Word32

parseParamList :: Text -> Either Text [Word32]

ParsableParam Word64

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Word64

parseParamList :: Text -> Either Text [Word64]

ParsableParam ()

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text ()

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

ParsableParam ByteString

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text ByteString

parseParamList :: Text -> Either Text [ByteString]

ParsableParam ByteString

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text ByteString

parseParamList :: Text -> Either Text [ByteString]

ParsableParam Text

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text Text

parseParamList :: Text -> Either Text [Text]

ParsableParam Text

Defined in Web.Twain.Types

Methods

parseParam :: Text0 -> Either Text0 Text

parseParamList :: Text0 -> Either Text0 [Text]

ParsableParam a => ParsableParam [a]

Defined in Web.Twain.Types

Methods

parseParam :: Text -> Either Text [a]

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

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

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