WebGear.Core.Handler

WebGear handlers

Documentation

class (ArrowChoice h, ArrowPlus h, ArrowError RouteMismatch h, Monad m) => Handler h m | h -> m where

A handler is an arrow with a monadic context.

Handlers have the following capabilities:

• Lift a monadic action into a handler arrow.
• Implement ArrowChoice typeclass so that conditionals can be used in arrow code.
• Implement ArrowPlus for routing requests to specific handlers.
• Provide contextual documentation elements - description and summary

Methods

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

Lift a monadic function to a handler arrow

consumeRoute :: h RoutePath a -> h () a

Consume all remaining path components with an arrow

setDescription :: Description -> h a a

Set a description of a part of an API

setSummary :: Summary -> h a a

Set a summary of a part of an API

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]

Show RoutePath

Defined in WebGear.Core.Handler

Methods

showsPrec :: Int -> RoutePath -> ShowS

show :: RoutePath -> String

showList :: [RoutePath] -> ShowS

Eq RoutePath

Defined in WebGear.Core.Handler

Methods

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

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

type Item RoutePath

Defined in WebGear.Core.Handler

type Item RoutePath = Text

data RouteMismatch

Indicates that a handler cannot process this route

Constructors

RouteMismatch

Instances

Monoid RouteMismatch

Defined in WebGear.Core.Handler

Methods

mempty :: RouteMismatch

mappend :: RouteMismatch -> RouteMismatch -> RouteMismatch

mconcat :: [RouteMismatch] -> RouteMismatch

Semigroup RouteMismatch

Defined in WebGear.Core.Handler

Methods

(<>) :: RouteMismatch -> RouteMismatch -> RouteMismatch

sconcat :: NonEmpty RouteMismatch -> RouteMismatch

stimes :: Integral b => b -> RouteMismatch -> RouteMismatch

Show RouteMismatch

Defined in WebGear.Core.Handler

Methods

showsPrec :: Int -> RouteMismatch -> ShowS

show :: RouteMismatch -> String

showList :: [RouteMismatch] -> ShowS

Eq RouteMismatch

Defined in WebGear.Core.Handler

Methods

(==) :: RouteMismatch -> RouteMismatch -> Bool

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

Ord RouteMismatch

Defined in WebGear.Core.Handler

Methods

compare :: RouteMismatch -> RouteMismatch -> Ordering

(<) :: RouteMismatch -> RouteMismatch -> Bool

(<=) :: RouteMismatch -> RouteMismatch -> Bool

(>) :: RouteMismatch -> RouteMismatch -> Bool

(>=) :: RouteMismatch -> RouteMismatch -> Bool

max :: RouteMismatch -> RouteMismatch -> RouteMismatch

min :: RouteMismatch -> RouteMismatch -> RouteMismatch

newtype Description

Description associated with part of an API

Constructors

Description

Fields

• getDescription :: Text

Instances

IsString Description

Defined in WebGear.Core.Handler

Methods

fromString :: String -> Description

Read Description

Defined in WebGear.Core.Handler

Methods

readsPrec :: Int -> ReadS Description

readList :: ReadS [Description]

readPrec :: ReadPrec Description

readListPrec :: ReadPrec [Description]

Show Description

Defined in WebGear.Core.Handler

Methods

showsPrec :: Int -> Description -> ShowS

show :: Description -> String

showList :: [Description] -> ShowS

Eq Description

Defined in WebGear.Core.Handler

Methods

(==) :: Description -> Description -> Bool

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

Ord Description

Defined in WebGear.Core.Handler

Methods

compare :: Description -> Description -> Ordering

(<) :: Description -> Description -> Bool

(<=) :: Description -> Description -> Bool

(>) :: Description -> Description -> Bool

(>=) :: Description -> Description -> Bool

max :: Description -> Description -> Description

min :: Description -> Description -> Description

newtype Summary

A summary associated with part of an API

Constructors

Summary

Fields

• getSummary :: Text

Instances

IsString Summary

Defined in WebGear.Core.Handler

Methods

fromString :: String -> Summary

Read Summary

Defined in WebGear.Core.Handler

Methods

readsPrec :: Int -> ReadS Summary

readList :: ReadS [Summary]

readPrec :: ReadPrec Summary

readListPrec :: ReadPrec [Summary]

Show Summary

Defined in WebGear.Core.Handler

Methods

showsPrec :: Int -> Summary -> ShowS

show :: Summary -> String

showList :: [Summary] -> ShowS

Eq Summary

Defined in WebGear.Core.Handler

Methods

(==) :: Summary -> Summary -> Bool

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

Ord Summary

Defined in WebGear.Core.Handler

Methods

compare :: Summary -> Summary -> Ordering

(<) :: Summary -> Summary -> Bool

(<=) :: Summary -> Summary -> Bool

(>) :: Summary -> Summary -> Bool

(>=) :: Summary -> Summary -> Bool

max :: Summary -> Summary -> Summary

min :: Summary -> Summary -> Summary

type RequestHandler h req = h (Linked req Request) Response

A handler arrow from a linked request to response.

type Middleware h reqOut reqIn = RequestHandler h reqIn -> RequestHandler h reqOut

A middleware enhances a RequestHandler and produces another handler.

routeMismatch :: ArrowError RouteMismatch h => h a b

Indicates that the request does not match the current handler.

unlinkA :: Handler h m => h (Linked ts Response) Response

Lifts unlink into a handler arrow.