Serv.Internal.Server.Type

Documentation

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 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 ServerValue

A return value from a Server computation.

Constructors

RoutingError RoutingError

Routing errors arise when a routing attempt fails and, depending on the error, either we should recover and backtrack or resolve the entire response with that error.

WaiResponse Response

If the response is arising from the Server computation itself it will be transformed automatically into a Response value we can handle directly. These are opaque to routing, assumed successes.

Application Application

If the application demands an "upgrade" or ties into another server mechanism then routing at that location will return the (opaque) Application to continue handling.

runServerWai :: Context -> (Response -> IO ResponseReceived) -> Server IO -> IO ResponseReceived

newtype Server m

Constructors

Server

Fields

• runServer :: Context -> m ServerValue

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

orElse :: Monad m => Server m -> Server m -> Server m

Servers form a semigroup trying each Server in order and receiving the leftmost one which does not end in an ignorable error.

Or, with less technical jargon, m orElse n acts like m except in the case where m returns an ignorable Error in which case control flows on to n.

routingError :: Monad m => RoutingError -> m ServerValue

data Response headers body where

Responses generated in Server implementations.

Constructors

Response :: Status -> [Header] -> Rec headers -> a -> Response headers (Body ctypes a)

EmptyResponse :: Status -> [Header] -> Rec headers -> Response headers Empty

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.

resortHeaders :: RecordIso headers headers' => Response headers body -> Response headers' body

If a response type is complete defined by its implementation then applying resorted to it will future proof it against reorderings of headers. If the response type is not completely inferrable, however, then this will require manual annotations of the "pre-sorted" response.

deleteBody :: Response headers body -> Response headers Empty

Used primarily for implementing HEAD request automatically.

class ReflectHeaders headers => WaiResponse headers body where

Minimal complete definition

waiResponse

Methods

waiResponse :: [Quality MediaType] -> Response headers body -> Response

Instances

ReflectHeaders HeaderName headers => WaiResponse headers (Empty *)

Methods

waiResponse :: [Quality MediaType] -> Response headers (Empty *) -> Response

(ReflectHeaders HeaderName headers, ReflectEncoders [*] ctypes a) => WaiResponse headers (Body * ctypes a)

Methods

waiResponse :: [Quality MediaType] -> Response headers (Body * ctypes a) -> Response