Safe Haskell	None
Language	Haskell98

Web.Spock.Wire

Synopsis

Documentation

type SpockRoutingTree m = RoutingTree (ActionT m ()) Source

type SpockTreeMap m = HashMap StdMethod (SpockRoutingTree m) Source

type SpockRouteMap m = HashMap StdMethod (HashMap Text (ActionT m ())) Source

data SpockState m Source

Constructors

SpockState
Fields ss_treeMap :: !(SpockRouteMap m) ss_middleware :: [Middleware] ss_spockLift :: forall a. m a -> IO a

Instances

Monad m => MonadState (SpockState m) (SpockT m)

data UploadedFile Source

Constructors

UploadedFile
Fields uf_name :: Text uf_contentType :: Text uf_tempLocation :: FilePath

data RequestInfo Source

Constructors

RequestInfo
Fields ri_request :: Request ri_params :: HashMap CaptureVar Text ri_queryParams :: [(Text, Text)] ri_files :: HashMap Text UploadedFile

Instances

Monad m => MonadReader RequestInfo (ActionT m)

data ResponseBody Source

Constructors

ResponseFile FilePath
ResponseLBS ByteString
ResponseRedirect Text

Instances

Eq ResponseBody
Show ResponseBody

data ResponseState Source

Constructors

ResponseState
Fields rs_responseHeaders :: [(Text, Text)] rs_status :: Status rs_responseBody :: ResponseBody

Instances

Eq ResponseState
Show ResponseState
Monad m => MonadState ResponseState (ActionT m)

type BaseRoute = Text Source

data ActionInterupt Source

Constructors

ActionRedirect Text
ActionTryNext
ActionError String
ActionDone

Instances

Show ActionInterupt
Error ActionInterupt
Monad m => MonadError ActionInterupt (ActionT m)

newtype ActionT m a Source

Constructors

ActionT
Fields runActionT :: ErrorT ActionInterupt (RWST RequestInfo () ResponseState m) a

Instances

MonadTrans ActionT
Monad m => MonadError ActionInterupt (ActionT m)
Monad m => MonadReader RequestInfo (ActionT m)
Monad m => MonadState ResponseState (ActionT m)
Monad m => Monad (ActionT m)
Functor m => Functor (ActionT m)
(Monad m, Functor m) => Applicative (ActionT m)
MonadIO m => MonadIO (ActionT m)

newtype SpockT m a Source

Constructors

SpockT
Fields runSpockT :: RWST BaseRoute () (SpockState m) m a

Instances

MonadTrans SpockT
Monad m => MonadReader BaseRoute (SpockT m)
Monad m => Monad (SpockT m)
Functor m => Functor (SpockT m)
(Monad m, Functor m) => Applicative (SpockT m)
MonadIO m => MonadIO (SpockT m)
Monad m => MonadState (SpockState m) (SpockT m)

respStateToResponse :: ResponseState -> Response Source

errorResponse :: Status -> ByteString -> ResponseState Source

notFound :: Response Source

invalidReq :: Response Source

serverError :: ResponseState Source

buildApp :: forall m. MonadIO m => (forall a. m a -> IO a) -> SpockT m () -> IO Application Source

middleware :: MonadIO m => Middleware -> SpockT m () Source

Hook up a Middleware

defRoute :: MonadIO m => StdMethod -> Text -> ActionT m () -> SpockT m () Source

Define a route matching a provided StdMethod and route

combineRoute :: Text -> Text -> Text Source

Combine two routes, ensuring that the slashes don't get messed up

subcomponent :: MonadIO m => Text -> SpockT m a -> SpockT m a Source

Define a subcomponent

subcomponent "/api" $
   do get "/user" $ text "USER"
      post "/new-user" $ text "OK!"

>>> curl http://localhost:8080/api/user
USER

buildRoutingTree :: SpockRouteMap m -> SpockTreeMap m Source