WebGear.Server.Handler

Server implementation of WebGear handlers

Documentation

newtype ServerHandler m a b

An arrow implementing a WebGear server.

It can be thought of equivalent to the function arrow a -> m b where m is a monad. It also supports routing and possibly failing the computation when the route does not match.

Constructors

ServerHandler

Fields

• unServerHandler :: (a, RoutePath) -> m (Either RouteMismatch b, RoutePath)

Instances

Monad m => ArrowError RouteMismatch (ServerHandler m)

Defined in WebGear.Server.Handler

Methods

raise :: ServerHandler m RouteMismatch b

handle :: ServerHandler m e b -> ServerHandler m (e, RouteMismatch) b -> ServerHandler m e b

tryInUnless :: ServerHandler m e b -> ServerHandler m (e, b) c -> ServerHandler m (e, RouteMismatch) c -> ServerHandler m e c

newError :: ServerHandler m e b -> ServerHandler m e (Either RouteMismatch b)

Monad m => Arrow (ServerHandler m)

Defined in WebGear.Server.Handler

Methods

arr :: (b -> c) -> ServerHandler m b c

first :: ServerHandler m b c -> ServerHandler m (b, d) (c, d)

second :: ServerHandler m b c -> ServerHandler m (d, b) (d, c)

(***) :: ServerHandler m b c -> ServerHandler m b' c' -> ServerHandler m (b, b') (c, c')

(&&&) :: ServerHandler m b c -> ServerHandler m b c' -> ServerHandler m b (c, c')

Monad m => ArrowZero (ServerHandler m)

Defined in WebGear.Server.Handler

Methods

zeroArrow :: ServerHandler m b c

Monad m => ArrowPlus (ServerHandler m)

Defined in WebGear.Server.Handler

Methods

(<+>) :: ServerHandler m b c -> ServerHandler m b c -> ServerHandler m b c

Monad m => ArrowChoice (ServerHandler m)

Defined in WebGear.Server.Handler

Methods

left :: ServerHandler m b c -> ServerHandler m (Either b d) (Either c d)

right :: ServerHandler m b c -> ServerHandler m (Either d b) (Either d c)

(+++) :: ServerHandler m b c -> ServerHandler m b' c' -> ServerHandler m (Either b b') (Either c c')

(|||) :: ServerHandler m b d -> ServerHandler m c d -> ServerHandler m (Either b c) d

Monad m => Handler (ServerHandler m) m

Defined in WebGear.Server.Handler

Methods

arrM :: (a -> m b) -> ServerHandler m a b

consumeRoute :: ServerHandler m RoutePath a -> ServerHandler m () a

setDescription :: Description -> ServerHandler m a a

setSummary :: Summary -> ServerHandler m a a

Monad m => Get (ServerHandler m) Method Request

Defined in WebGear.Server.Trait.Method

Methods

getTrait :: forall (ts :: [Type]). Method -> ServerHandler m (Linked ts Request) (Either (Absence Method Request) (Attribute Method Request))

Monad m => Get (ServerHandler m) PathEnd Request

Defined in WebGear.Server.Trait.Path

Methods

getTrait :: forall (ts :: [Type]). PathEnd -> ServerHandler m (Linked ts Request) (Either (Absence PathEnd Request) (Attribute PathEnd Request))

Monad m => Get (ServerHandler m) Path Request

Defined in WebGear.Server.Trait.Path

Methods

getTrait :: forall (ts :: [Type]). Path -> ServerHandler m (Linked ts Request) (Either (Absence Path Request) (Attribute Path Request))

Monad m => Set (ServerHandler m) Status Response

Defined in WebGear.Server.Trait.Status

Methods

setTrait :: forall (ts :: [Type]). Status -> (Linked ts Response -> Response -> Attribute Status Response -> Linked (Status ': ts) Response) -> ServerHandler m (Linked ts Response, Attribute Status Response) (Linked (Status ': ts) Response)

Monad m => Category (ServerHandler m :: Type -> Type -> Type)

Defined in WebGear.Server.Handler

Methods

id :: forall (a :: k). ServerHandler m a a

(.) :: forall (b :: k) (c :: k) (a :: k). ServerHandler m b c -> ServerHandler m a b -> ServerHandler m a c

(MonadIO m, FromJSON val) => Get (ServerHandler m) (JSONBody val) Request

Defined in WebGear.Server.Trait.Body

Methods

getTrait :: forall (ts :: [Type]). JSONBody val -> ServerHandler m (Linked ts Request) (Either (Absence (JSONBody val) Request) (Attribute (JSONBody val) Request))

(MonadIO m, FromByteString val) => Get (ServerHandler m) (Body val) Request

Defined in WebGear.Server.Trait.Body

Methods

getTrait :: forall (ts :: [Type]). Body val -> ServerHandler m (Linked ts Request) (Either (Absence (Body val) Request) (Attribute (Body val) Request))

(Monad m, ToJSON val) => Set (ServerHandler m) (JSONBody val) Response

Defined in WebGear.Server.Trait.Body

Methods

setTrait :: forall (ts :: [Type]). JSONBody val -> (Linked ts Response -> Response -> Attribute (JSONBody val) Response -> Linked (JSONBody val ': ts) Response) -> ServerHandler m (Linked ts Response, Attribute (JSONBody val) Response) (Linked (JSONBody val ': ts) Response)

(Monad m, ToByteString val) => Set (ServerHandler m) (Body val) Response

Defined in WebGear.Server.Trait.Body

Methods

setTrait :: forall (ts :: [Type]). Body val -> (Linked ts Response -> Response -> Attribute (Body val) Response -> Linked (Body val ': ts) Response) -> ServerHandler m (Linked ts Response, Attribute (Body val) Response) (Linked (Body val ': ts) Response)

(Monad m, FromHttpApiData val) => Get (ServerHandler m) (PathVar tag val) Request

Defined in WebGear.Server.Trait.Path

Methods

getTrait :: forall (ts :: [Type]). PathVar tag val -> ServerHandler m (Linked ts Request) (Either (Absence (PathVar tag val) Request) (Attribute (PathVar tag val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (Header 'Optional 'Lenient name val) Request

Defined in WebGear.Server.Trait.Header

Methods

getTrait :: forall (ts :: [Type]). Header 'Optional 'Lenient name val -> ServerHandler m (Linked ts Request) (Either (Absence (Header 'Optional 'Lenient name val) Request) (Attribute (Header 'Optional 'Lenient name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (Header 'Required 'Lenient name val) Request

Defined in WebGear.Server.Trait.Header

Methods

getTrait :: forall (ts :: [Type]). Header 'Required 'Lenient name val -> ServerHandler m (Linked ts Request) (Either (Absence (Header 'Required 'Lenient name val) Request) (Attribute (Header 'Required 'Lenient name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (Header 'Optional 'Strict name val) Request

Defined in WebGear.Server.Trait.Header

Methods

getTrait :: forall (ts :: [Type]). Header 'Optional 'Strict name val -> ServerHandler m (Linked ts Request) (Either (Absence (Header 'Optional 'Strict name val) Request) (Attribute (Header 'Optional 'Strict name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (Header 'Required 'Strict name val) Request

Defined in WebGear.Server.Trait.Header

Methods

getTrait :: forall (ts :: [Type]). Header 'Required 'Strict name val -> ServerHandler m (Linked ts Request) (Either (Absence (Header 'Required 'Strict name val) Request) (Attribute (Header 'Required 'Strict name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (QueryParam 'Optional 'Lenient name val) Request

Defined in WebGear.Server.Trait.QueryParam

Methods

getTrait :: forall (ts :: [Type]). QueryParam 'Optional 'Lenient name val -> ServerHandler m (Linked ts Request) (Either (Absence (QueryParam 'Optional 'Lenient name val) Request) (Attribute (QueryParam 'Optional 'Lenient name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (QueryParam 'Required 'Lenient name val) Request

Defined in WebGear.Server.Trait.QueryParam

Methods

getTrait :: forall (ts :: [Type]). QueryParam 'Required 'Lenient name val -> ServerHandler m (Linked ts Request) (Either (Absence (QueryParam 'Required 'Lenient name val) Request) (Attribute (QueryParam 'Required 'Lenient name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (QueryParam 'Optional 'Strict name val) Request

Defined in WebGear.Server.Trait.QueryParam

Methods

getTrait :: forall (ts :: [Type]). QueryParam 'Optional 'Strict name val -> ServerHandler m (Linked ts Request) (Either (Absence (QueryParam 'Optional 'Strict name val) Request) (Attribute (QueryParam 'Optional 'Strict name val) Request))

(Monad m, KnownSymbol name, FromHttpApiData val) => Get (ServerHandler m) (QueryParam 'Required 'Strict name val) Request

Defined in WebGear.Server.Trait.QueryParam

Methods

getTrait :: forall (ts :: [Type]). QueryParam 'Required 'Strict name val -> ServerHandler m (Linked ts Request) (Either (Absence (QueryParam 'Required 'Strict name val) Request) (Attribute (QueryParam 'Required 'Strict name val) Request))

(Monad m, KnownSymbol name, ToByteString val) => Set (ServerHandler m) (Header 'Optional 'Strict name val) Response

Defined in WebGear.Server.Trait.Header

Methods

setTrait :: forall (ts :: [Type]). Header 'Optional 'Strict name val -> (Linked ts Response -> Response -> Attribute (Header 'Optional 'Strict name val) Response -> Linked (Header 'Optional 'Strict name val ': ts) Response) -> ServerHandler m (Linked ts Response, Attribute (Header 'Optional 'Strict name val) Response) (Linked (Header 'Optional 'Strict name val ': ts) Response)

(Monad m, KnownSymbol name, ToByteString val) => Set (ServerHandler m) (Header 'Required 'Strict name val) Response

Defined in WebGear.Server.Trait.Header

Methods

setTrait :: forall (ts :: [Type]). Header 'Required 'Strict name val -> (Linked ts Response -> Response -> Attribute (Header 'Required 'Strict name val) Response -> Linked (Header 'Required 'Strict name val ': ts) Response) -> ServerHandler m (Linked ts Response, Attribute (Header 'Required 'Strict name val) Response) (Linked (Header 'Required 'Strict name val ': ts) Response)

(Monad m, Get (ServerHandler m) (AuthorizationHeader scheme) Request) => Get (ServerHandler m) (BasicAuth' 'Optional scheme m e a) Request

Defined in WebGear.Server.Trait.Auth.Basic

Methods

getTrait :: forall (ts :: [Type]). BasicAuth' 'Optional scheme m e a -> ServerHandler m (Linked ts Request) (Either (Absence (BasicAuth' 'Optional scheme m e a) Request) (Attribute (BasicAuth' 'Optional scheme m e a) Request))

(Monad m, Get (ServerHandler m) (AuthorizationHeader scheme) Request) => Get (ServerHandler m) (BasicAuth' 'Required scheme m e a) Request

Defined in WebGear.Server.Trait.Auth.Basic

Methods

getTrait :: forall (ts :: [Type]). BasicAuth' 'Required scheme m e a -> ServerHandler m (Linked ts Request) (Either (Absence (BasicAuth' 'Required scheme m e a) Request) (Attribute (BasicAuth' 'Required scheme m e a) Request))

(MonadTime m, Get (ServerHandler m) (AuthorizationHeader scheme) Request) => Get (ServerHandler m) (JWTAuth' 'Optional scheme m e a) Request

Defined in WebGear.Server.Trait.Auth.JWT

Methods

getTrait :: forall (ts :: [Type]). JWTAuth' 'Optional scheme m e a -> ServerHandler m (Linked ts Request) (Either (Absence (JWTAuth' 'Optional scheme m e a) Request) (Attribute (JWTAuth' 'Optional scheme m e a) Request))

(MonadTime m, Get (ServerHandler m) (AuthorizationHeader scheme) Request) => Get (ServerHandler m) (JWTAuth' 'Required scheme m e a) Request

Defined in WebGear.Server.Trait.Auth.JWT

Methods

getTrait :: forall (ts :: [Type]). JWTAuth' 'Required scheme m e a -> ServerHandler m (Linked ts Request) (Either (Absence (JWTAuth' 'Required scheme m e a) Request) (Attribute (JWTAuth' 'Required scheme m e a) Request))

newtype RoutePath

Parts of the request path used by the routing machinery

Constructors

RoutePath [Text]

Instances

IsList RoutePath

Defined in WebGear.Core.Handler

Associated Types

type Item RoutePath

Methods

fromList :: [Item RoutePath] -> RoutePath

fromListN :: Int -> [Item RoutePath] -> RoutePath

toList :: RoutePath -> [Item RoutePath]

Eq RoutePath

Defined in WebGear.Core.Handler

Methods

(==) :: RoutePath -> RoutePath -> Bool

(/=) :: RoutePath -> RoutePath -> Bool

Show RoutePath

Defined in WebGear.Core.Handler

Methods

showsPrec :: Int -> RoutePath -> ShowS

show :: RoutePath -> String

showList :: [RoutePath] -> ShowS

type Item RoutePath

Defined in WebGear.Core.Handler

type Item RoutePath = Text

runServerHandler

Arguments

:: Monad m

=> ServerHandler m a b

The handler to run

-> RoutePath

Path used for routing

-> a

Input value to the arrow

-> m (Either RouteMismatch b)

The result of the arrow

Run a ServerHandler to produce a result or a route mismatch error.

toApplication :: ServerHandler IO (Linked '[] Request) Response -> Application

Convert a ServerHandler to a WAI application

transform :: (forall x. m x -> n x) -> ServerHandler m a b -> ServerHandler n a b

Transform a ServerHandler running in one monad to another monad.

This is useful in cases where the server is running in a custom monad but you would like to convert it to a WAI application using toApplication.

Example usage with a ReaderT monad stack:

 toApplication (transform f server)
   where
     server :: ServerHandler (ReaderT r IO) (Linked '[] Request) Response
     server = ....

     f :: ReaderT r IO a -> IO a
     f action = runReaderT action r