Safe Haskell	None
Language	Haskell2010

Web.Spock.Core

Contents

Lauching Spock
Spock's route definition monad
Defining routes
Rendering routes
Hooking routes
Adding Wai.Middleware
Actions
Config
Internals

Synopsis

runSpock :: Port -> IO Middleware -> IO ()
runSpockNoBanner :: Port -> IO Middleware -> IO ()
spockAsApp :: IO Middleware -> IO Application
spockT :: MonadIO m => (forall a. m a -> IO a) -> SpockT m () -> IO Middleware
spockConfigT :: forall m. MonadIO m => SpockConfig -> (forall a. m a -> IO a) -> SpockT m () -> IO Middleware
type SpockT = SpockCtxT ()
data SpockCtxT ctx m a
data Path (as :: [Type]) (pathState :: PathState)
root :: Path ('[] :: [Type]) 'Open
type Var a = Path '[a] 'Open
var :: (Typeable a, FromHttpApiData a) => Path '[a] 'Open
static :: String -> Path ('[] :: [Type]) 'Open
(<//>) :: Path as 'Open -> Path bs ps -> Path (Append as bs) ps
wildcard :: Path '[Text] 'Closed
renderRoute :: AllHave ToHttpApiData as => Path as 'Open -> HVectElim as Text
prehook :: (RouteM t, MonadIO m) => ActionCtxT ctx m ctx' -> t ctx' m () -> t ctx m ()
get :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
post :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
getpost :: (HasRep xs, RouteM t, Monad m, Monad (t ctx m)) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
head :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
put :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
delete :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
patch :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
hookRoute :: (HasRep xs, RouteM t, Monad m) => StdMethod -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
hookRouteCustom :: (HasRep xs, RouteM t, Monad m) => Text -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
hookAny :: (RouteM t, Monad m) => StdMethod -> ([Text] -> ActionCtxT ctx m ()) -> t ctx m ()
hookAnyCustom :: (RouteM t, Monad m) => Text -> ([Text] -> ActionCtxT ctx m ()) -> t ctx m ()
hookRouteAll :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
hookAnyAll :: (RouteM t, Monad m) => ([Text] -> ActionCtxT ctx m ()) -> t ctx m ()
data StdMethod
- = GET
- | POST
- | HEAD
- | PUT
- | DELETE
- | TRACE
- | CONNECT
- | OPTIONS
- | PATCH
middleware :: (RouteM t, Monad m) => Middleware -> t ctx m ()
module Web.Spock.Action
data SpockConfig = SpockConfig {
- sc_maxRequestSize :: Maybe Word64
- sc_errorHandler :: Status -> ActionCtxT () IO ()
- sc_logError :: Text -> IO ()
}
defaultSpockConfig :: SpockConfig
hookRoute' :: (HasRep xs, RouteM t, Monad m) => SpockMethod -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m ()
hookAny' :: (RouteM t, Monad m) => SpockMethod -> ([Text] -> ActionCtxT ctx m ()) -> t ctx m ()
data SpockMethod
- = MethodStandard !HttpMethod
- | MethodCustom !Text
- | MethodAny
newtype HttpMethod = HttpMethod {
- unHttpMethod :: StdMethod
}

Lauching Spock

runSpock :: Port -> IO Middleware -> IO () Source #

Run a Spock application. Basically just a wrapper around run.

runSpockNoBanner :: Port -> IO Middleware -> IO () Source #

Like runSpock, but does not display the banner "Spock is running on port XXX" on stdout.

spockAsApp :: IO Middleware -> IO Application Source #

Convert a middleware to an application. All failing requests will result in a 404 page

Spock's route definition monad

spockT :: MonadIO m => (forall a. m a -> IO a) -> SpockT m () -> IO Middleware Source #

Create a raw spock application with custom underlying monad Use runSpock to run the app or spockAsApp to create a Wai.Application The first argument is request size limit in bytes. Set to Nothing to disable.

spockConfigT :: forall m. MonadIO m => SpockConfig -> (forall a. m a -> IO a) -> SpockT m () -> IO Middleware Source #

Like spockT, but with additional configuration for request size and error handlers passed as first parameter.

type SpockT = SpockCtxT () Source #

data SpockCtxT ctx m a Source #

Instances

Instances details

RouteM SpockCtxT Source #
Instance details Defined in Web.Spock.Core Methods addMiddleware :: forall (m :: Type -> Type) ctx. Monad m => Middleware -> SpockCtxT ctx m () Source # withPrehook :: forall (m :: Type -> Type) ctx ctx'. MonadIO m => ActionCtxT ctx m ctx' -> SpockCtxT ctx' m () -> SpockCtxT ctx m () Source # wireAny :: forall (m :: Type -> Type) ctx. Monad m => SpockMethod -> ([Text] -> ActionCtxT ctx m ()) -> SpockCtxT ctx m () Source # wireRoute :: forall (m :: Type -> Type) (xs :: [Type]) (ps :: PathState) ctx. (Monad m, HasRep xs) => SpockMethod -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> SpockCtxT ctx m () Source #
MonadTrans (SpockCtxT ctx) Source #
Instance details Defined in Web.Spock.Core Methods lift :: Monad m => m a -> SpockCtxT ctx m a #
Monad m => Monad (SpockCtxT ctx m) Source #
Instance details Defined in Web.Spock.Core Methods (>>=) :: SpockCtxT ctx m a -> (a -> SpockCtxT ctx m b) -> SpockCtxT ctx m b # (>>) :: SpockCtxT ctx m a -> SpockCtxT ctx m b -> SpockCtxT ctx m b # return :: a -> SpockCtxT ctx m a #
Functor m => Functor (SpockCtxT ctx m) Source #
Instance details Defined in Web.Spock.Core Methods fmap :: (a -> b) -> SpockCtxT ctx m a -> SpockCtxT ctx m b # (<$) :: a -> SpockCtxT ctx m b -> SpockCtxT ctx m a #
Monad m => Applicative (SpockCtxT ctx m) Source #
Instance details Defined in Web.Spock.Core Methods pure :: a -> SpockCtxT ctx m a # (<>) :: SpockCtxT ctx m (a -> b) -> SpockCtxT ctx m a -> SpockCtxT ctx m b # liftA2 :: (a -> b -> c) -> SpockCtxT ctx m a -> SpockCtxT ctx m b -> SpockCtxT ctx m c # (>) :: SpockCtxT ctx m a -> SpockCtxT ctx m b -> SpockCtxT ctx m b # (<*) :: SpockCtxT ctx m a -> SpockCtxT ctx m b -> SpockCtxT ctx m a #
MonadIO m => MonadIO (SpockCtxT ctx m) Source #
Instance details Defined in Web.Spock.Core Methods liftIO :: IO a -> SpockCtxT ctx m a #

Defining routes

data Path (as :: [Type]) (pathState :: PathState) #

Instances

Instances details

(a ~ ('[] :: [Type]), pathState ~ 'Open) => IsString (Path a pathState)
Instance details Defined in Web.Routing.Combinators Methods fromString :: String -> Path a pathState #

root :: Path ('[] :: [Type]) 'Open #

The root of a path piece. Use to define a handler for "/"

type Var a = Path '[a] 'Open #

var :: (Typeable a, FromHttpApiData a) => Path '[a] 'Open #

A route parameter

static :: String -> Path ('[] :: [Type]) 'Open #

A static route piece

(<//>) :: Path as 'Open -> Path bs ps -> Path (Append as bs) ps Source #

Combine two path components

wildcard :: Path '[Text] 'Closed #

Matches the rest of the route. Should be the last part of the path.

Rendering routes

renderRoute :: AllHave ToHttpApiData as => Path as 'Open -> HVectElim as Text Source #

Render a route applying path pieces

Hooking routes

prehook :: (RouteM t, MonadIO m) => ActionCtxT ctx m ctx' -> t ctx' m () -> t ctx m () Source #

Specify an action that will be run before all subroutes. It can modify the requests current context

get :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb GET and the given route match

post :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb POST and the given route match

getpost :: (HasRep xs, RouteM t, Monad m, Monad (t ctx m)) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb GET/POST and the given route match

head :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb HEAD and the given route match

put :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb PUT and the given route match

delete :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb DELETE and the given route match

patch :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when the HTTP verb PATCH and the given route match

hookRoute :: (HasRep xs, RouteM t, Monad m) => StdMethod -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when a standard HTTP verb and the given route match

hookRouteCustom :: (HasRep xs, RouteM t, Monad m) => Text -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when a custom HTTP verb and the given route match

hookAny :: (RouteM t, Monad m) => StdMethod -> ([Text] -> ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when a standard HTTP verb matches but no defined route matches. The full path is passed as an argument

hookAnyCustom :: (RouteM t, Monad m) => Text -> ([Text] -> ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when a custom HTTP verb matches but no defined route matches. The full path is passed as an argument

hookRouteAll :: (HasRep xs, RouteM t, Monad m) => Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run regardless of the HTTP verb

hookAnyAll :: (RouteM t, Monad m) => ([Text] -> ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run regardless of the HTTP verb and no defined route matches. The full path is passed as an argument

data StdMethod #

HTTP standard method (as defined by RFC 2616, and PATCH which is defined by RFC 5789).

Constructors

GET
POST
HEAD
PUT
DELETE
TRACE
CONNECT
OPTIONS
PATCH

Instances

Instances details

Bounded StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods minBound :: StdMethod # maxBound :: StdMethod #
Enum StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods succ :: StdMethod -> StdMethod # pred :: StdMethod -> StdMethod # toEnum :: Int -> StdMethod # fromEnum :: StdMethod -> Int # enumFrom :: StdMethod -> [StdMethod] # enumFromThen :: StdMethod -> StdMethod -> [StdMethod] # enumFromTo :: StdMethod -> StdMethod -> [StdMethod] # enumFromThenTo :: StdMethod -> StdMethod -> StdMethod -> [StdMethod] #
Eq StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods (==) :: StdMethod -> StdMethod -> Bool # (/=) :: StdMethod -> StdMethod -> Bool #
Ord StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods compare :: StdMethod -> StdMethod -> Ordering # (<) :: StdMethod -> StdMethod -> Bool # (<=) :: StdMethod -> StdMethod -> Bool # (>) :: StdMethod -> StdMethod -> Bool # (>=) :: StdMethod -> StdMethod -> Bool # max :: StdMethod -> StdMethod -> StdMethod # min :: StdMethod -> StdMethod -> StdMethod #
Read StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods readsPrec :: Int -> ReadS StdMethod # readList :: ReadS [StdMethod] # readPrec :: ReadPrec StdMethod # readListPrec :: ReadPrec [StdMethod] #
Show StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods showsPrec :: Int -> StdMethod -> ShowS # show :: StdMethod -> String # showList :: [StdMethod] -> ShowS #
Ix StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods range :: (StdMethod, StdMethod) -> [StdMethod] # index :: (StdMethod, StdMethod) -> StdMethod -> Int # unsafeIndex :: (StdMethod, StdMethod) -> StdMethod -> Int # inRange :: (StdMethod, StdMethod) -> StdMethod -> Bool # rangeSize :: (StdMethod, StdMethod) -> Int # unsafeRangeSize :: (StdMethod, StdMethod) -> Int #

Adding Wai.Middleware

middleware :: (RouteM t, Monad m) => Middleware -> t ctx m () Source #

Hook wai middleware into Spock

Actions

module Web.Spock.Action

Config

data SpockConfig Source #

Constructors

SpockConfig
Fields sc_maxRequestSize :: Maybe Word64 Maximum request size in bytes sc_errorHandler :: Status -> ActionCtxT () IO () Error handler. Given status is set in response by default, but you can always override it with `setStatus` sc_logError :: Text -> IO () Function that should be called to log errors.

defaultSpockConfig :: SpockConfig Source #

Default Spock configuration. No restriction on maximum request size; error handler simply prints status message as plain text and all errors are logged to stderr.

Internals

hookRoute' :: (HasRep xs, RouteM t, Monad m) => SpockMethod -> Path xs ps -> HVectElim xs (ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when a HTTP verb and the given route match

hookAny' :: (RouteM t, Monad m) => SpockMethod -> ([Text] -> ActionCtxT ctx m ()) -> t ctx m () Source #

Specify an action that will be run when a HTTP verb matches but no defined route matches. The full path is passed as an argument

data SpockMethod Source #

The SpockMethod allows safe use of http verbs via the MethodStandard constructor and StdMethod, and custom verbs via the MethodCustom constructor.

Constructors

MethodStandard !HttpMethod	Standard HTTP Verbs from `StdMethod`
MethodCustom !Text	Custom HTTP Verbs using `Text`
MethodAny	Match any HTTP verb

Instances

Instances details

Eq SpockMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods (==) :: SpockMethod -> SpockMethod -> Bool # (/=) :: SpockMethod -> SpockMethod -> Bool #
Generic SpockMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Associated Types type Rep SpockMethod :: Type -> Type # Methods from :: SpockMethod -> Rep SpockMethod x # to :: Rep SpockMethod x -> SpockMethod #
Hashable SpockMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods hashWithSalt :: Int -> SpockMethod -> Int # hash :: SpockMethod -> Int #
type Rep SpockMethod Source #
Instance details Defined in Web.Spock.Internal.Wire type Rep SpockMethod = D1 ('MetaData "SpockMethod" "Web.Spock.Internal.Wire" "Spock-core-0.14.0.0-K2pbC2tVT8aBDrFhli6pMZ" 'False) (C1 ('MetaCons "MethodStandard" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HttpMethod)) :+: (C1 ('MetaCons "MethodCustom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "MethodAny" 'PrefixI 'False) (U1 :: Type -> Type)))

newtype HttpMethod Source #

Constructors

HttpMethod
Fields unHttpMethod :: StdMethod

Instances

Instances details

Bounded HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods minBound :: HttpMethod # maxBound :: HttpMethod #
Enum HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods succ :: HttpMethod -> HttpMethod # pred :: HttpMethod -> HttpMethod # toEnum :: Int -> HttpMethod # fromEnum :: HttpMethod -> Int # enumFrom :: HttpMethod -> [HttpMethod] # enumFromThen :: HttpMethod -> HttpMethod -> [HttpMethod] # enumFromTo :: HttpMethod -> HttpMethod -> [HttpMethod] # enumFromThenTo :: HttpMethod -> HttpMethod -> HttpMethod -> [HttpMethod] #
Eq HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods (==) :: HttpMethod -> HttpMethod -> Bool # (/=) :: HttpMethod -> HttpMethod -> Bool #
Show HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods showsPrec :: Int -> HttpMethod -> ShowS # show :: HttpMethod -> String # showList :: [HttpMethod] -> ShowS #
Generic HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Associated Types type Rep HttpMethod :: Type -> Type # Methods from :: HttpMethod -> Rep HttpMethod x # to :: Rep HttpMethod x -> HttpMethod #
Hashable HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire Methods hashWithSalt :: Int -> HttpMethod -> Int # hash :: HttpMethod -> Int #
type Rep HttpMethod Source #
Instance details Defined in Web.Spock.Internal.Wire type Rep HttpMethod = D1 ('MetaData "HttpMethod" "Web.Spock.Internal.Wire" "Spock-core-0.14.0.0-K2pbC2tVT8aBDrFhli6pMZ" 'True) (C1 ('MetaCons "HttpMethod" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHttpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StdMethod)))