Serv.Server

Documentation

data Server m

transformServer :: (forall x. m x -> n x) -> Server m -> Server n

makeApplication :: Config -> Server IO -> Application

Build a Application from an implemented Server IO.

data Config

defaultConfig :: Config

class Handling spec where

The the core type function responsible for interpreting an Api into a functioning Server. It defines a function handle defined over all forms of Api types which consumes a parallel type defined by the associated type family Impl. If api :: Api then Impl api m is an "implementation" of the Api's server logic executing in the m monad. Then, applying handle to a value of Impl api results in a Server which can be executed as a Application.

Minimal complete definition

handle

Associated Types

type Impl spec (m :: * -> *)

Methods

handle :: Monad m => Proxy spec -> Impl spec m -> Server m

Instances

Handling [k] ([] k)

Associated Types

type Impl ([] k) (spec :: [] k) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy [k] spec -> Impl [k] spec m -> Server m

Handling (Api star) (Raw star)

Associated Types

type Impl (Raw star) (spec :: Raw star) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (Raw star) spec -> Impl (Raw star) spec m -> Server m

(VerbsOf [Method *] methods, HeadersReturnedBy methods, HeadersExpectedOf methods, Handling [Method *] methods) => Handling (Api *) (Endpoint * methods)

Associated Types

type Impl (Endpoint * methods) (spec :: Endpoint * methods) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (Endpoint * methods) spec -> Impl (Endpoint * methods) spec m -> Server m

Handling [Api star] apis => Handling (Api star) (OneOf star apis)

Associated Types

type Impl (OneOf star apis) (spec :: OneOf star apis) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (OneOf star apis) spec -> Impl (OneOf star apis) spec m -> Server m

(Handling a x, Handling [a] xs) => Handling [a] ((:) a x xs)

Associated Types

type Impl ((:) a x xs) (spec :: (:) a x xs) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((a ': x) xs) spec -> Impl ((a ': x) xs) spec m -> Server m

Handling (Method *) method => Handling (Method *) (CaptureHeaders * headers method)

Associated Types

type Impl (CaptureHeaders * headers method) (spec :: CaptureHeaders * headers method) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (CaptureHeaders * headers method) spec -> Impl (CaptureHeaders * headers method) spec m -> Server m

Handling (Method *) method => Handling (Method *) (CaptureQuery * query method)

Associated Types

type Impl (CaptureQuery * query method) (spec :: CaptureQuery * query method) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (CaptureQuery * query method) spec -> Impl (CaptureQuery * query method) spec m -> Server m

(URIDecode v, Handling (Api *) api) => Handling (Api *) ((:>) * (Seg * n v) api)

Associated Types

type Impl ((:>) * (Seg * n v) api) (spec :: (:>) * (Seg * n v) api) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((* :> Seg * n v) api) spec -> Impl ((* :> Seg * n v) api) spec m -> Server m

(HeaderDecode n v, Handling (Api *) api) => Handling (Api *) ((:>) * (Header * n v) api)

Associated Types

type Impl ((:>) * (Header * n v) api) (spec :: (:>) * (Header * n v) api) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((* :> Header * n v) api) spec -> Impl ((* :> Header * n v) api) spec m -> Server m

(Handling (Api *) api, CorsPolicy p) => Handling (Api *) ((:>) * (Cors * p) api)

Associated Types

type Impl ((:>) * (Cors * p) api) (spec :: (:>) * (Cors * p) api) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((* :> Cors * p) api) spec -> Impl ((* :> Cors * p) api) spec m -> Server m

(ReflectName n, KnownSymbol v, Handling (Api star) api) => Handling (Api star) ((:>) star (HeaderAs star n v) api)

Associated Types

type Impl ((:>) star (HeaderAs star n v) api) (spec :: (:>) star (HeaderAs star n v) api) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((star :> HeaderAs star n v) api) spec -> Impl ((star :> HeaderAs star n v) api) spec m -> Server m

Handling (Api star) api => Handling (Api star) ((:>) star (Wildcard star) api)

Associated Types

type Impl ((:>) star (Wildcard star) api) (spec :: (:>) star (Wildcard star) api) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((star :> Wildcard star) api) spec -> Impl ((star :> Wildcard star) api) spec m -> Server m

(KnownSymbol s, Handling (Api star) api) => Handling (Api star) ((:>) star (Const star s) api)

Associated Types

type Impl ((:>) star (Const star s) api) (spec :: (:>) star (Const star s) api) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy ((star :> Const star s) api) spec -> Impl ((star :> Const star s) api) spec m -> Server m

(ReflectVerb verb, WaiResponse headers body) => Handling (Method *) (Method * verb headers body)

Associated Types

type Impl (Method * verb headers body) (spec :: Method * verb headers body) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (Method * verb headers body) spec -> Impl (Method * verb headers body) spec m -> Server m

WaiResponse headers body => Handling (Method *) (Method * GET headers body)

GET is special-cased to handle HEAD semantics which cannot be specified otherwise.

Associated Types

type Impl (Method * GET headers body) (spec :: Method * GET headers body) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (Method * GET headers body) spec -> Impl (Method * GET headers body) spec m -> Server m

Handling (Method *) method => Handling (Method *) (CaptureBody * ctypes value method)

Associated Types

type Impl (CaptureBody * ctypes value method) (spec :: CaptureBody * ctypes value method) (m :: * -> *) :: *

Methods

handle :: Monad m => Proxy (CaptureBody * ctypes value method) spec -> Impl (CaptureBody * ctypes value method) spec m -> Server m

data a :<|> b infixr 5

Either one thing or the other. In particular, often this is used when we are describing either one server implementation or the other. Used to give semantics to 'OneOf and 'Endpoint.

Constructors

a :<|> b infixr 5

data NotHere

A server implementation which always results in a "Not Found" error. Used to give semantics to "pathological" servers like 'OneOf '[] and Endpoint '[].

These servers could be statically disallowed but (1) they have a semantic sense as described by this type exactly and (2) to do so would require the creation and management of either larger types or non-empty proofs which would be burdensome to carry about.

Constructors

NotHere

noOp :: Applicative m => m NotHere

Actual servers are implemented effectfully; this is a no-op server which immediately returns Not Found and applies no effects.

data Response headers body

Responses generated in Server implementations.

emptyResponse :: Status -> Response '[] Empty

withBody :: a -> Response headers Empty -> Response headers (Body ctypes a)

Adds a body to a response

withHeader :: Proxy name -> value -> Response headers body -> Response ((name ::: value) ': headers) body

Adds a header to a response

withQuietHeader :: HeaderEncode name value => Proxy name -> value -> Response headers body -> Response headers body

Unlike withHeader, withQuietHeader allows you to add headers not explicitly specified in the api specification.

module Network.HTTP.Types.Status

module Data.Tagged