Web.Eved

Documentation

class Eved api m | api -> m

Minimal complete definition

(.<|>), lit, capture, reqBody, queryParam, verb

Instances

Eved EvedClient ClientM

Defined in Web.Eved.Client

Methods

(.<|>) :: EvedClient a -> EvedClient b -> EvedClient (a :<|> b)

lit :: Text -> EvedClient a -> EvedClient a

capture :: Text -> UrlElement a -> EvedClient b -> EvedClient (a -> b)

reqBody :: NonEmpty (ContentType a) -> EvedClient b -> EvedClient (a -> b)

queryParam :: Text -> QueryParam a -> EvedClient b -> EvedClient (a -> b)

verb :: StdMethod -> Status -> NonEmpty (ContentType a) -> EvedClient (ClientM a)

Eved (EvedServerT m) m

Defined in Web.Eved.Server

Methods

(.<|>) :: EvedServerT m a -> EvedServerT m b -> EvedServerT m (a :<|> b)

lit :: Text -> EvedServerT m a -> EvedServerT m a

capture :: Text -> UrlElement a -> EvedServerT m b -> EvedServerT m (a -> b)

reqBody :: NonEmpty (ContentType a) -> EvedServerT m b -> EvedServerT m (a -> b)

queryParam :: Text -> QueryParam a -> EvedServerT m b -> EvedServerT m (a -> b)

verb :: StdMethod -> Status -> NonEmpty (ContentType a) -> EvedServerT m (m a)

Eved (EvedOptions m) m

Defined in Web.Eved.Options

Methods

(.<|>) :: EvedOptions m a -> EvedOptions m b -> EvedOptions m (a :<|> b)

lit :: Text -> EvedOptions m a -> EvedOptions m a

capture :: Text -> UrlElement a -> EvedOptions m b -> EvedOptions m (a -> b)

reqBody :: NonEmpty (ContentType a) -> EvedOptions m b -> EvedOptions m (a -> b)

queryParam :: Text -> QueryParam a -> EvedOptions m b -> EvedOptions m (a -> b)

verb :: StdMethod -> Status -> NonEmpty (ContentType a) -> EvedOptions m (m a)

data a :<|> b infixl 4

Constructors

a :<|> b infixl 4

(.</>) :: (Applicative f, Eved api m) => (f (api a) -> f (api b)) -> f (api a) -> f (api b) infixr 5

A Segment seperator to be used between path segments akin to / in a url e.g. lit "hello" ./ capture "name" UE.text ./ get [CT.json @Text]

(.<|>) :: (Eved api m, Applicative f) => f (api a) -> f (api b) -> f (api (a :<|> b))

Combine two sub-api's by trying the left api first and then the right api second.

lit :: (Eved api m, Applicative f) => Text -> f (api a) -> f (api a)

Add a Literal string to the path of the api

capture :: (Eved api m, Applicative f) => Text -> f (UrlElement a) -> f (api b) -> f (api (a -> b))

Add a url capture with a given name and UrlElement decoder/encoder

reqBody :: (Eved api m, Applicative f) => NonEmpty (f (ContentType a)) -> f (api b) -> f (api (a -> b))

Add a request body parser for the given content types The Content-Type header will be examined to assist in content negotiation.

queryParam :: (Eved api m, Applicative f) => Text -> f (QueryParam a) -> f (api b) -> f (api (a -> b))

A single query param that is required to exist. If the argument is not required use QP.maybe

verb :: (Eved api m, Applicative f) => StdMethod -> Status -> NonEmpty (f (ContentType a)) -> f (api (m a))

The leaf node of most routes, this will specify the HTTP Verb and Status along with a list of ContentType encoder/decoders. The Allow header in the request will be examined to determine a suitable response Content-Type

get :: (Eved api m, Applicative f) => NonEmpty (f (ContentType a)) -> f (api (m a))

HTTP GET -- see verb for more info

post :: (Eved api m, Applicative f) => NonEmpty (f (ContentType a)) -> f (api (m a))

HTTP POST -- see verb for more info

put :: (Eved api m, Applicative f) => NonEmpty (f (ContentType a)) -> f (api (m a))

HTTP PUT -- see verb for more info

patch :: (Eved api m, Applicative f) => NonEmpty (f (ContentType a)) -> f (api (m a))

HTTP PATCH -- see verb for more info

delete :: (Eved api m, Applicative f) => NonEmpty (f (ContentType a)) -> f (api (m a))

HTTP DELETE -- see verb for more info

runClientIO :: ClientM a -> IO a

runClient :: (MonadIO m, MonadReader env m, HasHttpManager env) => ClientM a -> m a

noContext :: Eved api m => Identity (api a) -> api a

Unwrap an api that requires no context. If none of the combinators that were used required any context use this function to unwrap the api

withContext :: Eved api m => ctx -> (ctx -> api a) -> api a

data ClientM a

Instances

Eved EvedClient ClientM

Defined in Web.Eved.Client

Methods

(.<|>) :: EvedClient a -> EvedClient b -> EvedClient (a :<|> b)

lit :: Text -> EvedClient a -> EvedClient a

capture :: Text -> UrlElement a -> EvedClient b -> EvedClient (a -> b)

reqBody :: NonEmpty (ContentType a) -> EvedClient b -> EvedClient (a -> b)

queryParam :: Text -> QueryParam a -> EvedClient b -> EvedClient (a -> b)

verb :: StdMethod -> Status -> NonEmpty (ContentType a) -> EvedClient (ClientM a)

data EvedServerT m a

Instances

EvedAuth (EvedServerT m)

Defined in Web.Eved.Auth

Methods

auth_ :: NonEmpty (AuthScheme a) -> EvedServerT m b -> EvedServerT m (a -> b)

Eved (EvedServerT m) m

Defined in Web.Eved.Server

Methods

(.<|>) :: EvedServerT m a -> EvedServerT m b -> EvedServerT m (a :<|> b)

lit :: Text -> EvedServerT m a -> EvedServerT m a

capture :: Text -> UrlElement a -> EvedServerT m b -> EvedServerT m (a -> b)

reqBody :: NonEmpty (ContentType a) -> EvedServerT m b -> EvedServerT m (a -> b)

queryParam :: Text -> QueryParam a -> EvedServerT m b -> EvedServerT m (a -> b)

verb :: StdMethod -> Status -> NonEmpty (ContentType a) -> EvedServerT m (m a)

server :: (forall a. m a -> IO a) -> a -> EvedServerT m a -> Application