Safe Haskell	None
Language	Haskell2010

Trasa.Core

Contents

Types
- Existential
Request Types
Using Routes
Defining Routes
Codecs
- Converting Codecs
- Type Class based Codecs
Argument Currying
Helpers

Synopsis

data Bodiedness
- = Body a
- | Bodyless
data Content = Content {
- contentType :: !MediaType
- contentData :: !ByteString
}
data Payload = Payload {
- payloadUrl :: !Url
- payloadContent :: !(Maybe Content)
- payloadAccepts :: !(NonEmpty MediaType)
}
data Router route
data Prepared :: ([Type] -> [Param] -> Bodiedness -> Type -> Type) -> Type -> Type where
- Prepared :: !(route captures querys request response) -> !(Rec Identity captures) -> !(Rec Parameter querys) -> !(RequestBody Identity request) -> Prepared route response
data Concealed :: ([Type] -> [Param] -> Bodiedness -> Type -> Type) -> Type where
- Concealed :: !(route captures querys request response) -> !(Rec Identity captures) -> !(Rec Parameter querys) -> !(RequestBody Identity request) -> Concealed route
data Constructed :: ([Type] -> [Param] -> Bodiedness -> Type -> Type) -> Type where
- Constructed :: !(route captures querys request response) -> Constructed route
conceal :: Prepared route response -> Concealed route
concealedToPrepared :: forall route a. Concealed route -> (forall resp. Prepared route resp -> a) -> a
mapConstructed :: (forall caps qrys req resp. sub caps qrys req resp -> route caps qrys req resp) -> Constructed sub -> Constructed route
data Method
encodeMethod :: Method -> Text
decodeMethod :: Text -> Method
newtype QueryString = QueryString {
- unQueryString :: HashMap Text QueryParam
}
encodeQuery :: QueryString -> Query
decodeQuery :: Query -> QueryString
data Url = Url {
- urlPath :: ![Text]
- urlQueryString :: !QueryString
}
encodeUrl :: Url -> Text
decodeUrl :: Text -> Url
data TrasaErr = TrasaErr {
- trasaErrStatus :: Status
- trasaErrBody :: ByteString
}
status :: Status -> TrasaErr
prepareWith :: (forall caps qrys req resp. route caps qrys req resp -> Meta capCodec qryCodec reqCodec respCodec caps qrys req resp) -> route captures query request response -> Arguments captures query request (Prepared route response)
linkWith :: forall route response reqCodec respCodec. (forall caps qrys req resp. route caps qrys req resp -> Meta CaptureEncoding CaptureEncoding reqCodec respCodec caps qrys req resp) -> Prepared route response -> Url
dispatchWith :: forall route m. Applicative m => (forall caps qrys req resp. route caps qrys req resp -> MetaServer caps qrys req resp) -> (forall caps qrys req resp. route caps qrys req resp -> Rec Identity caps -> Rec Parameter qrys -> RequestBody Identity req -> m resp) -> Router route -> Method -> [MediaType] -> Url -> Maybe Content -> m (Either TrasaErr Content)
parseWith :: forall route capCodec respCodec. (forall caps qrys req resp. route caps qrys req resp -> Meta capCodec CaptureDecoding (Many BodyDecoding) respCodec caps qrys req resp) -> Router route -> Method -> Url -> Maybe Content -> Either TrasaErr (Concealed route)
payloadWith :: forall route response. (forall caps qrys req resp. route caps qrys req resp -> MetaClient caps qrys req resp) -> Prepared route response -> Payload
requestWith :: Functor m => (forall caps qrys req resp. route caps qrys req resp -> MetaClient caps qrys req resp) -> (Method -> Url -> Maybe Content -> NonEmpty MediaType -> m (Either TrasaErr Content)) -> Prepared route response -> m (Either TrasaErr response)
routerWith :: forall route qryCodec reqCodec respCodec. (forall caps qrys req resp. route caps qrys req resp -> Meta CaptureDecoding qryCodec reqCodec respCodec caps qrys req resp) -> [Constructed route] -> Router route
data Path :: (Type -> Type) -> [Type] -> Type where
- PathNil :: Path cap '[]
- PathConsCapture :: !(cap a) -> !(Path cap as) -> Path cap (a ': as)
- PathConsMatch :: !Text -> !(Path cap as) -> Path cap as
match :: Text -> Path cpf caps -> Path cpf caps
capture :: cpf cap -> Path cpf caps -> Path cpf (cap ': caps)
end :: Path cpf '[]
(./) :: (a -> b) -> a -> b
mapPath :: (forall x. cf x -> cf' x) -> Path cf ps -> Path cf' ps
appendPath :: Path f as -> Path f bs -> Path f (as ++ bs)
data Param
- = Flag
- | Optional a
- | List a
data Query :: (Type -> Type) -> Param -> Type where
- QueryFlag :: !Text -> Query cap Flag
- QueryOptional :: !Text -> !(cap a) -> Query cap (Optional a)
- QueryList :: !Text -> !(cap a) -> Query cap (List a)
data Parameter :: Param -> Type where
- ParameterFlag :: !Bool -> Parameter Flag
- ParameterOptional :: !(Maybe a) -> Parameter (Optional a)
- ParameterList :: ![a] -> Parameter (List a)
data Rec (a :: k -> Type) (b :: [k]) :: forall k. (k -> Type) -> [k] -> Type where
- RecNil :: forall k (a :: k -> Type) (b :: [k]). Rec a ([] :: [k])
- RecCons :: forall k (a :: k -> Type) (b :: [k]) (r :: k) (rs :: [k]). a r -> Rec a rs -> Rec a (r ': rs)
demoteParameter :: Parameter param -> ParamBase param
flag :: Text -> Query cpf Flag
optional :: Text -> cpf query -> Query cpf (Optional query)
list :: Text -> cpf query -> Query cpf (List query)
qend :: Rec (Query qpf) '[]
(.&) :: Query qpf q -> Rec (Query qpf) qs -> Rec (Query qpf) (q ': qs)
mapQuery :: (forall x. f x -> g x) -> Rec (Query f) qs -> Rec (Query g) qs
data RequestBody :: (Type -> Type) -> Bodiedness -> Type where
- RequestBodyPresent :: !(f a) -> RequestBody f (Body a)
- RequestBodyAbsent :: RequestBody f Bodyless
body :: rqf req -> RequestBody rqf (Body req)
bodyless :: RequestBody rqf Bodyless
encodeRequestBody :: RequestBody (Many BodyEncoding) request -> RequestBody Identity request -> Maybe Content
decodeRequestBody :: RequestBody (Many BodyDecoding) req -> Maybe Content -> Either TrasaErr (RequestBody Identity req)
mapRequestBody :: (forall x. rqf x -> rqf' x) -> RequestBody rqf request -> RequestBody rqf' request
newtype ResponseBody rpf response = ResponseBody {
- getResponseBody :: rpf response
}
resp :: rpf resp -> ResponseBody rpf resp
encodeResponseBody :: forall response. [MediaType] -> ResponseBody (Many BodyEncoding) response -> response -> Either TrasaErr Content
decodeResponseBody :: ResponseBody (Many BodyDecoding) response -> Content -> Either TrasaErr response
mapResponseBody :: (forall x. rpf x -> rpf' x) -> ResponseBody rpf request -> ResponseBody rpf' request
newtype Many f a = Many {
- getMany :: NonEmpty (f a)
}
one :: f a -> Many f a
mapMany :: (forall x. f x -> g x) -> Many f a -> Many g a
data Meta capCodec qryCodec reqCodec respCodec caps qrys req resp = Meta {
- metaPath :: !(Path capCodec caps)
- metaQuery :: !(Rec (Query qryCodec) qrys)
- metaRequestBody :: !(RequestBody reqCodec req)
- metaResponseBody :: !(ResponseBody respCodec resp)
- metaMethod :: !Method
}
type MetaBuilder = Meta CaptureCodec CaptureCodec BodyCodec BodyCodec
metaBuilderToMetaCodec :: Meta capCodec qryCodec reqCodec respCodec caps qrys req resp -> Meta capCodec qryCodec (Many reqCodec) (Many respCodec) caps qrys req resp
type MetaCodec = Meta CaptureCodec CaptureCodec (Many BodyCodec) (Many BodyCodec)
type MetaClient = Meta CaptureEncoding CaptureEncoding (Many BodyEncoding) (Many BodyDecoding)
metaCodecToMetaClient :: MetaCodec caps qrys req resp -> MetaClient caps qrys req resp
type MetaServer = Meta CaptureDecoding CaptureDecoding (Many BodyDecoding) (Many BodyEncoding)
metaCodecToMetaServer :: MetaCodec caps qrys req resp -> MetaServer caps qrys req resp
mapMetaPath :: (forall x. cf x -> cg x) -> Meta cf qryCodec reqCodec respCodec caps qrys req resp -> Meta cg qryCodec reqCodec respCodec caps qrys req resp
mapMetaQuery :: (forall x. qf x -> qg x) -> Meta capCodec qf reqCodec respCodec caps qrys req resp -> Meta capCodec qg reqCodec respCodec caps qrys req resp
mapMetaRequestBody :: (forall x. rf x -> rg x) -> Meta capCodec qryCodec rf respCodec caps qrys req resp -> Meta capCodec qryCodec rg respCodec caps qrys req resp
mapMetaResponseBody :: (forall x. rf x -> rg x) -> Meta capCodec qryCodec reqCodec rf caps qrys req resp -> Meta capCodec qryCodec reqCodec rg caps qrys req resp
mapMeta :: (forall x. capCodec1 x -> capCodec2 x) -> (forall x. qryCodec1 x -> qryCodec2 x) -> (forall x. reqCodec1 x -> reqCodec2 x) -> (forall x. respCodec1 x -> respCodec2 x) -> Meta capCodec1 qryCodec1 reqCodec1 respCodec1 caps qrys req resp -> Meta capCodec2 qryCodec2 reqCodec2 respCodec2 caps qrys req resp
newtype CaptureEncoding a = CaptureEncoding {
- appCaptureEncoding :: a -> Text
}
class HasCaptureEncoding capStrategy where
- captureEncoding :: capStrategy a -> CaptureEncoding a
newtype CaptureDecoding a = CaptureDecoding {
- appCaptureDecoding :: Text -> Maybe a
}
class HasCaptureDecoding capStrategy where
- captureDecoding :: capStrategy a -> CaptureDecoding a
data CaptureCodec a = CaptureCodec {
- captureCodecEncode :: a -> Text
- captureCodecDecode :: Text -> Maybe a
}
class HasCaptureCodec capStrategy where
- captureCodec :: capStrategy a -> CaptureCodec a
data BodyEncoding a = BodyEncoding {
- bodyEncodingNames :: NonEmpty MediaType
- bodyEncodingFunction :: a -> ByteString
}
class HasBodyEncoding bodyStrategy where
- bodyEncoding :: bodyStrategy a -> BodyEncoding a
data BodyDecoding a = BodyDecoding {
- bodyDecodingNames :: NonEmpty MediaType
- bodyDecodingFunction :: ByteString -> Either Text a
}
class HasBodyDecoding bodyStrategy where
- bodyDecoding :: bodyStrategy a -> BodyDecoding a
data BodyCodec a = BodyCodec {
- bodyCodecNames :: NonEmpty MediaType
- bodyCodecEncode :: a -> ByteString
- bodyCodecDecode :: ByteString -> Either Text a
}
class HasBodyCodec bodyStrategy where
- bodyCodec :: bodyStrategy a -> BodyCodec a
captureCodecToCaptureEncoding :: CaptureCodec a -> CaptureEncoding a
captureCodecToCaptureDecoding :: CaptureCodec a -> CaptureDecoding a
bodyCodecToBodyEncoding :: BodyCodec a -> BodyEncoding a
bodyCodecToBodyDecoding :: BodyCodec a -> BodyDecoding a
showReadCaptureCodec :: (Show a, Read a) => CaptureCodec a
showReadBodyCodec :: (Show a, Read a) => BodyCodec a
type family ParamBase (param :: Param) :: Type where ...
type family Arguments (pieces :: [Type]) (querys :: [Param]) (body :: Bodiedness) (result :: Type) :: Type where ...
handler :: forall captures querys request x. Rec Identity captures -> Rec Parameter querys -> RequestBody Identity request -> Arguments captures querys request x -> x
prettyRouter :: Router route -> String

Types

data Bodiedness Source #

the type of the HTTP message body (json, text, etc) https://en.wikipedia.org/wiki/HTTP_message_body

Constructors

Body a
Bodyless

data Content Source #

The HTTP content type and body.

Constructors

Content
Fields contentType :: !MediaType contentData :: !ByteString

Instances

Eq Content Source #
Instance details Defined in Trasa.Core Methods (==) :: Content -> Content -> Bool # (/=) :: Content -> Content -> Bool #
Ord Content Source #
Instance details Defined in Trasa.Core Methods compare :: Content -> Content -> Ordering # (<) :: Content -> Content -> Bool # (<=) :: Content -> Content -> Bool # (>) :: Content -> Content -> Bool # (>=) :: Content -> Content -> Bool # max :: Content -> Content -> Content # min :: Content -> Content -> Content #
Show Content Source #
Instance details Defined in Trasa.Core Methods showsPrec :: Int -> Content -> ShowS # show :: Content -> String # showList :: [Content] -> ShowS #

data Payload Source #

Constructors

Payload
Fields payloadUrl :: !Url payloadContent :: !(Maybe Content) payloadAccepts :: !(NonEmpty MediaType)

data Router route Source #

Existential

data Prepared :: ([Type] -> [Param] -> Bodiedness -> Type -> Type) -> Type -> Type where Source #

Includes the route, path, query parameters, and request body.

Constructors

Prepared :: !(route captures querys request response) -> !(Rec Identity captures) -> !(Rec Parameter querys) -> !(RequestBody Identity request) -> Prepared route response

data Concealed :: ([Type] -> [Param] -> Bodiedness -> Type -> Type) -> Type where Source #

Only needed to implement parseWith. Most users do not need this. If you need to create a route hierarchy to provide breadcrumbs, then you will need this.

Constructors

Concealed :: !(route captures querys request response) -> !(Rec Identity captures) -> !(Rec Parameter querys) -> !(RequestBody Identity request) -> Concealed route

data Constructed :: ([Type] -> [Param] -> Bodiedness -> Type -> Type) -> Type where Source #

A route with all types hidden: the captures, the request body, and the response body. This is needed so that users can enumerate over all the routes.

Constructors

Constructed :: !(route captures querys request response) -> Constructed route

conceal :: Prepared route response -> Concealed route Source #

Conceal the response type.

concealedToPrepared :: forall route a. Concealed route -> (forall resp. Prepared route resp -> a) -> a Source #

mapConstructed :: (forall caps qrys req resp. sub caps qrys req resp -> route caps qrys req resp) -> Constructed sub -> Constructed route Source #

Request Types

Method

data Method Source #

Instances

Eq Method Source #
Instance details Defined in Trasa.Method Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Ord Method Source #
Instance details Defined in Trasa.Method Methods compare :: Method -> Method -> Ordering # (<) :: Method -> Method -> Bool # (<=) :: Method -> Method -> Bool # (>) :: Method -> Method -> Bool # (>=) :: Method -> Method -> Bool # max :: Method -> Method -> Method # min :: Method -> Method -> Method #
Show Method Source #
Instance details Defined in Trasa.Method Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
IsString Method Source #
Instance details Defined in Trasa.Method Methods fromString :: String -> Method #
Hashable Method Source #
Instance details Defined in Trasa.Method Methods hashWithSalt :: Int -> Method -> Int # hash :: Method -> Int #

encodeMethod :: Method -> Text Source #

decodeMethod :: Text -> Method Source #

Queries

newtype QueryString Source #

Constructors

QueryString
Fields unQueryString :: HashMap Text QueryParam

Instances

Eq QueryString Source #
Instance details Defined in Trasa.Url Methods (==) :: QueryString -> QueryString -> Bool # (/=) :: QueryString -> QueryString -> Bool #

encodeQuery :: QueryString -> Query Source #

decodeQuery :: Query -> QueryString Source #

Url

data Url Source #

Constructors

Url
Fields urlPath :: ![Text] urlQueryString :: !QueryString

Instances

Eq Url Source #
Instance details Defined in Trasa.Url Methods (==) :: Url -> Url -> Bool # (/=) :: Url -> Url -> Bool #
Show Url Source #
Instance details Defined in Trasa.Url Methods showsPrec :: Int -> Url -> ShowS # show :: Url -> String # showList :: [Url] -> ShowS #

encodeUrl :: Url -> Text Source #

decodeUrl :: Text -> Url Source #

Using Routes

prepareWith Source #

Arguments

:: (forall caps qrys req resp. route caps qrys req resp -> Meta capCodec qryCodec reqCodec respCodec caps qrys req resp)
-> route captures query request response	The route to prepare
-> Arguments captures query request (Prepared route response)

Used my users to define a function called prepare, see tutorial

linkWith Source #

Arguments

:: (forall caps qrys req resp. route caps qrys req resp -> Meta CaptureEncoding CaptureEncoding reqCodec respCodec caps qrys req resp)
-> Prepared route response	The route to encode
-> Url

Generate a Url for use in hyperlinks.

dispatchWith Source #

Arguments

:: Applicative m
=> (forall caps qrys req resp. route caps qrys req resp -> MetaServer caps qrys req resp)
-> (forall caps qrys req resp. route caps qrys req resp -> Rec Identity caps -> Rec Parameter qrys -> RequestBody Identity req -> m resp)
-> Router route	Router
-> Method	Method
-> [MediaType]	Accept headers
-> Url	Everything after the authority
-> Maybe Content	Content type and request body
-> m (Either TrasaErr Content)	Encoded response

Only useful to implement packages like 'trasa-server'

parseWith Source #

Arguments

:: (forall caps qrys req resp. route caps qrys req resp -> Meta capCodec CaptureDecoding (Many BodyDecoding) respCodec caps qrys req resp)
-> Router route	Router
-> Method	Request Method
-> Url	Everything after the authority
-> Maybe Content	Request content type and body
-> Either TrasaErr (Concealed route)

Parses the path, the querystring, and the request body.

payloadWith Source #

Arguments

:: (forall caps qrys req resp. route caps qrys req resp -> MetaClient caps qrys req resp)
-> Prepared route response	The route to be payload encoded
-> Payload

Only useful for library authors

requestWith Source #

Arguments

:: Functor m
=> (forall caps qrys req resp. route caps qrys req resp -> MetaClient caps qrys req resp)
-> (Method -> Url -> Maybe Content -> NonEmpty MediaType -> m (Either TrasaErr Content))	method, url, content, accepts -> response
-> Prepared route response
-> m (Either TrasaErr response)

routerWith :: forall route qryCodec reqCodec respCodec. (forall caps qrys req resp. route caps qrys req resp -> Meta CaptureDecoding qryCodec reqCodec respCodec caps qrys req resp) -> [Constructed route] -> Router route Source #

Build a router from all the possible routes, and methods to turn routes into needed metadata

Defining Routes

Path

data Path :: (Type -> Type) -> [Type] -> Type where Source #

Constructors

PathNil :: Path cap '[]
PathConsCapture :: !(cap a) -> !(Path cap as) -> Path cap (a ': as)
PathConsMatch :: !Text -> !(Path cap as) -> Path cap as

match :: Text -> Path cpf caps -> Path cpf caps Source #

capture :: cpf cap -> Path cpf caps -> Path cpf (cap ': caps) Source #

end :: Path cpf '[] Source #

(./) :: (a -> b) -> a -> b infixr 7 Source #

flipped ($), useful for constructing routes. e.g. > match "add" . capture int . capture int ./ end

mapPath :: (forall x. cf x -> cf' x) -> Path cf ps -> Path cf' ps Source #

appendPath :: Path f as -> Path f bs -> Path f (as ++ bs) Source #

Query

data Param Source #

Constructors

Flag
Optional a
List a

data Query :: (Type -> Type) -> Param -> Type where Source #

Constructors

QueryFlag :: !Text -> Query cap Flag
QueryOptional :: !Text -> !(cap a) -> Query cap (Optional a)
QueryList :: !Text -> !(cap a) -> Query cap (List a)

data Parameter :: Param -> Type where Source #

Constructors

ParameterFlag :: !Bool -> Parameter Flag
ParameterOptional :: !(Maybe a) -> Parameter (Optional a)
ParameterList :: ![a] -> Parameter (List a)

data Rec (a :: k -> Type) (b :: [k]) :: forall k. (k -> Type) -> [k] -> Type where #

Constructors

RecNil :: forall k (a :: k -> Type) (b :: [k]). Rec a ([] :: [k])
RecCons :: forall k (a :: k -> Type) (b :: [k]) (r :: k) (rs :: [k]). a r -> Rec a rs -> Rec a (r ': rs)

Instances

TestCoercion f => TestCoercion (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods testCoercion :: Rec f a -> Rec f b -> Maybe (Coercion a b) #
TestEquality f => TestEquality (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods testEquality :: Rec f a -> Rec f b -> Maybe (a :~: b) #
EqForall f => EqForall (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods eqForall :: Rec f a -> Rec f a -> Bool #
EqForeach f => EqForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods eqForeach :: Sing a -> Rec f a -> Rec f a -> Bool #
OrdForall f => OrdForall (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods compareForall :: Rec f a -> Rec f a -> Ordering #
EqForallPoly f => EqForallPoly (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods eqForallPoly :: Rec f a -> Rec f b -> WitnessedEquality a b #
OrdForeach f => OrdForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods compareForeach :: Sing a -> Rec f a -> Rec f a -> Ordering #
ShowForall f => ShowForall (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods showsPrecForall :: Int -> Rec f a -> ShowS #
ShowForeach f => ShowForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods showsPrecForeach :: Sing a -> Int -> Rec f a -> ShowS #
HashableForall f => HashableForall (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods hashWithSaltForall :: Int -> Rec f a -> Int #
ToJSONForall f => ToJSONForall (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods toJSONForall :: Rec f a -> Value #
FromJSONForeach f => FromJSONForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods parseJSONForeach :: Sing a -> Value -> Parser (Rec f a) #
FromJSONExists f => FromJSONExists (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods parseJSONExists :: Value -> Parser (Exists (Rec f)) #
SemigroupForeach f => SemigroupForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods appendForeach :: Sing a -> Rec f a -> Rec f a -> Rec f a #
SemigroupForall f => SemigroupForall (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods appendForall :: Rec f a -> Rec f a -> Rec f a #
StorableForeach f => StorableForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods peekForeach :: Sing a -> Ptr (Rec f a) -> IO (Rec f a) # pokeForeach :: Sing a -> Ptr (Rec f a) -> Rec f a -> IO () # sizeOfForeach :: Proxy (Rec f) -> Sing a -> Int #
BinaryForeach f => BinaryForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods putForeach :: Sing a -> Rec f a -> Put # getForeach :: Sing a -> Get (Rec f a) #
MonoidForeach f => MonoidForeach (Rec f :: [k] -> Type)
Instance details Defined in Topaz.Types Methods emptyForeach :: Sing a -> Rec f a #
EqForall f => Eq (Rec f as)
Instance details Defined in Topaz.Types Methods (==) :: Rec f as -> Rec f as -> Bool # (/=) :: Rec f as -> Rec f as -> Bool #
OrdForall f => Ord (Rec f as)
Instance details Defined in Topaz.Types Methods compare :: Rec f as -> Rec f as -> Ordering # (<) :: Rec f as -> Rec f as -> Bool # (<=) :: Rec f as -> Rec f as -> Bool # (>) :: Rec f as -> Rec f as -> Bool # (>=) :: Rec f as -> Rec f as -> Bool # max :: Rec f as -> Rec f as -> Rec f as # min :: Rec f as -> Rec f as -> Rec f as #
ShowForall f => Show (Rec f as)
Instance details Defined in Topaz.Types Methods showsPrec :: Int -> Rec f as -> ShowS # show :: Rec f as -> String # showList :: [Rec f as] -> ShowS #
SemigroupForall f => Semigroup (Rec f as)
Instance details Defined in Topaz.Types Methods (<>) :: Rec f as -> Rec f as -> Rec f as # sconcat :: NonEmpty (Rec f as) -> Rec f as # stimes :: Integral b => b -> Rec f as -> Rec f as #
HashableForall f => Hashable (Rec f as)
Instance details Defined in Topaz.Types Methods hashWithSalt :: Int -> Rec f as -> Int # hash :: Rec f as -> Int #
ToJSONForall f => ToJSON (Rec f as)
Instance details Defined in Topaz.Types Methods toJSON :: Rec f as -> Value # toEncoding :: Rec f as -> Encoding # toJSONList :: [Rec f as] -> Value # toEncodingList :: [Rec f as] -> Encoding #
(FromJSONForeach f, Reify as) => FromJSON (Rec f as)
Instance details Defined in Topaz.Types Methods parseJSON :: Value -> Parser (Rec f as) # parseJSONList :: Value -> Parser [Rec f as] #
(StorableForeach f, Reify as) => Storable (Rec f as)
Instance details Defined in Topaz.Types Methods sizeOf :: Rec f as -> Int # alignment :: Rec f as -> Int # peekElemOff :: Ptr (Rec f as) -> Int -> IO (Rec f as) # pokeElemOff :: Ptr (Rec f as) -> Int -> Rec f as -> IO () # peekByteOff :: Ptr b -> Int -> IO (Rec f as) # pokeByteOff :: Ptr b -> Int -> Rec f as -> IO () # peek :: Ptr (Rec f as) -> IO (Rec f as) # poke :: Ptr (Rec f as) -> Rec f as -> IO () #

demoteParameter :: Parameter param -> ParamBase param Source #

flag :: Text -> Query cpf Flag Source #

optional :: Text -> cpf query -> Query cpf (Optional query) Source #

list :: Text -> cpf query -> Query cpf (List query) Source #

qend :: Rec (Query qpf) '[] Source #

(.&) :: Query qpf q -> Rec (Query qpf) qs -> Rec (Query qpf) (q ': qs) infixr 7 Source #

mapQuery :: (forall x. f x -> g x) -> Rec (Query f) qs -> Rec (Query g) qs Source #

Request Body

data RequestBody :: (Type -> Type) -> Bodiedness -> Type where Source #

Constructors

RequestBodyPresent :: !(f a) -> RequestBody f (Body a)
RequestBodyAbsent :: RequestBody f Bodyless

body :: rqf req -> RequestBody rqf (Body req) Source #

bodyless :: RequestBody rqf Bodyless Source #

encodeRequestBody :: RequestBody (Many BodyEncoding) request -> RequestBody Identity request -> Maybe Content Source #

decodeRequestBody :: RequestBody (Many BodyDecoding) req -> Maybe Content -> Either TrasaErr (RequestBody Identity req) Source #

mapRequestBody :: (forall x. rqf x -> rqf' x) -> RequestBody rqf request -> RequestBody rqf' request Source #

Response Body

newtype ResponseBody rpf response Source #

Constructors

ResponseBody
Fields getResponseBody :: rpf response

resp :: rpf resp -> ResponseBody rpf resp Source #

encodeResponseBody :: forall response. [MediaType] -> ResponseBody (Many BodyEncoding) response -> response -> Either TrasaErr Content Source #

decodeResponseBody :: ResponseBody (Many BodyDecoding) response -> Content -> Either TrasaErr response Source #

mapResponseBody :: (forall x. rpf x -> rpf' x) -> ResponseBody rpf request -> ResponseBody rpf' request Source #

Many

newtype Many f a Source #

Constructors

Many
Fields getMany :: NonEmpty (f a)

Instances

Functor f => Functor (Many f) Source #
Instance details Defined in Trasa.Core Methods fmap :: (a -> b) -> Many f a -> Many f b # (<$) :: a -> Many f b -> Many f a #
Applicative f => Applicative (Many f) Source #
Instance details Defined in Trasa.Core Methods pure :: a -> Many f a # (<>) :: Many f (a -> b) -> Many f a -> Many f b # liftA2 :: (a -> b -> c) -> Many f a -> Many f b -> Many f c # (>) :: Many f a -> Many f b -> Many f b # (<*) :: Many f a -> Many f b -> Many f a #

one :: f a -> Many f a Source #

mapMany :: (forall x. f x -> g x) -> Many f a -> Many g a Source #

Codecs

newtype CaptureEncoding a Source #

Constructors

CaptureEncoding
Fields appCaptureEncoding :: a -> Text

Instances

HasCaptureEncoding CaptureEncoding Source #
Instance details Defined in Trasa.Codec Methods captureEncoding :: CaptureEncoding a -> CaptureEncoding a Source #

class HasCaptureEncoding capStrategy where Source #

Methods

captureEncoding :: capStrategy a -> CaptureEncoding a Source #

Instances

HasCaptureEncoding CaptureCodec Source #
Instance details Defined in Trasa.Codec Methods captureEncoding :: CaptureCodec a -> CaptureEncoding a Source #
HasCaptureEncoding CaptureEncoding Source #
Instance details Defined in Trasa.Codec Methods captureEncoding :: CaptureEncoding a -> CaptureEncoding a Source #

newtype CaptureDecoding a Source #

Constructors

CaptureDecoding
Fields appCaptureDecoding :: Text -> Maybe a

Instances

HasCaptureDecoding CaptureDecoding Source #
Instance details Defined in Trasa.Codec Methods captureDecoding :: CaptureDecoding a -> CaptureDecoding a Source #

class HasCaptureDecoding capStrategy where Source #

Methods

captureDecoding :: capStrategy a -> CaptureDecoding a Source #

Instances

HasCaptureDecoding CaptureCodec Source #
Instance details Defined in Trasa.Codec Methods captureDecoding :: CaptureCodec a -> CaptureDecoding a Source #
HasCaptureDecoding CaptureDecoding Source #
Instance details Defined in Trasa.Codec Methods captureDecoding :: CaptureDecoding a -> CaptureDecoding a Source #

data CaptureCodec a Source #

Constructors

CaptureCodec
Fields captureCodecEncode :: a -> Text captureCodecDecode :: Text -> Maybe a

Instances

HasCaptureCodec CaptureCodec Source #
Instance details Defined in Trasa.Codec Methods captureCodec :: CaptureCodec a -> CaptureCodec a Source #
HasCaptureDecoding CaptureCodec Source #
Instance details Defined in Trasa.Codec Methods captureDecoding :: CaptureCodec a -> CaptureDecoding a Source #
HasCaptureEncoding CaptureCodec Source #
Instance details Defined in Trasa.Codec Methods captureEncoding :: CaptureCodec a -> CaptureEncoding a Source #

class HasCaptureCodec capStrategy where Source #

Methods

captureCodec :: capStrategy a -> CaptureCodec a Source #

Instances

HasCaptureCodec CaptureCodec Source #
Instance details Defined in Trasa.Codec Methods captureCodec :: CaptureCodec a -> CaptureCodec a Source #

data BodyEncoding a Source #

Constructors

BodyEncoding
Fields bodyEncodingNames :: NonEmpty MediaType bodyEncodingFunction :: a -> ByteString

Instances

HasBodyEncoding BodyEncoding Source #
Instance details Defined in Trasa.Codec Methods bodyEncoding :: BodyEncoding a -> BodyEncoding a Source #

class HasBodyEncoding bodyStrategy where Source #

Methods

bodyEncoding :: bodyStrategy a -> BodyEncoding a Source #

Instances

HasBodyEncoding BodyCodec Source #
Instance details Defined in Trasa.Codec Methods bodyEncoding :: BodyCodec a -> BodyEncoding a Source #
HasBodyEncoding BodyEncoding Source #
Instance details Defined in Trasa.Codec Methods bodyEncoding :: BodyEncoding a -> BodyEncoding a Source #

data BodyDecoding a Source #

Constructors

BodyDecoding
Fields bodyDecodingNames :: NonEmpty MediaType bodyDecodingFunction :: ByteString -> Either Text a

Instances

HasBodyDecoding BodyDecoding Source #
Instance details Defined in Trasa.Codec Methods bodyDecoding :: BodyDecoding a -> BodyDecoding a Source #

class HasBodyDecoding bodyStrategy where Source #

Methods

bodyDecoding :: bodyStrategy a -> BodyDecoding a Source #

Instances

HasBodyDecoding BodyCodec Source #
Instance details Defined in Trasa.Codec Methods bodyDecoding :: BodyCodec a -> BodyDecoding a Source #
HasBodyDecoding BodyDecoding Source #
Instance details Defined in Trasa.Codec Methods bodyDecoding :: BodyDecoding a -> BodyDecoding a Source #

data BodyCodec a Source #

Constructors

BodyCodec
Fields bodyCodecNames :: NonEmpty MediaType bodyCodecEncode :: a -> ByteString bodyCodecDecode :: ByteString -> Either Text a

Instances

HasBodyCodec BodyCodec Source #
Instance details Defined in Trasa.Codec Methods bodyCodec :: BodyCodec a -> BodyCodec a Source #
HasBodyDecoding BodyCodec Source #
Instance details Defined in Trasa.Codec Methods bodyDecoding :: BodyCodec a -> BodyDecoding a Source #
HasBodyEncoding BodyCodec Source #
Instance details Defined in Trasa.Codec Methods bodyEncoding :: BodyCodec a -> BodyEncoding a Source #

class HasBodyCodec bodyStrategy where Source #

Methods

bodyCodec :: bodyStrategy a -> BodyCodec a Source #

Instances

HasBodyCodec BodyCodec Source #
Instance details Defined in Trasa.Codec Methods bodyCodec :: BodyCodec a -> BodyCodec a Source #

Converting Codecs

captureCodecToCaptureEncoding :: CaptureCodec a -> CaptureEncoding a Source #

captureCodecToCaptureDecoding :: CaptureCodec a -> CaptureDecoding a Source #

bodyCodecToBodyEncoding :: BodyCodec a -> BodyEncoding a Source #

bodyCodecToBodyDecoding :: BodyCodec a -> BodyDecoding a Source #

Type Class based Codecs

showReadCaptureCodec :: (Show a, Read a) => CaptureCodec a Source #

showReadBodyCodec :: (Show a, Read a) => BodyCodec a Source #

Argument Currying

type family ParamBase (param :: Param) :: Type where ... Source #

Equations

ParamBase Flag = Bool
ParamBase (Optional a) = Maybe a
ParamBase (List a) = [a]

type family Arguments (pieces :: [Type]) (querys :: [Param]) (body :: Bodiedness) (result :: Type) :: Type where ... Source #

A closed, total type family provided as a convenience to end users. Other function is this library take advantage of Arguments to allow end users use normal function application. Without this, users would need to write out Record and RequestBody values by hand, which is tedious.

>>> :kind! Arguments '[Int,Bool] '[Flag,Optional Double,List Int] 'Bodyless Double
Arguments '[Int,Bool] '[Flag,Optional Double,List Int] 'Bodyless Double :: *
= Int -> Bool -> Bool -> Maybe Double -> [Int] -> Double

Equations

Arguments '[] '[] (Body b) r = b -> r
Arguments '[] '[] Bodyless r = r
Arguments '[] (q ': qs) r b = ParamBase q -> Arguments '[] qs r b
Arguments (c ': cs) qs b r = c -> Arguments cs qs b r

handler :: forall captures querys request x. Rec Identity captures -> Rec Parameter querys -> RequestBody Identity request -> Arguments captures querys request x -> x Source #

Uncurry the arguments type family

Helpers

prettyRouter :: Router route -> String Source #

Pretty prints a router, using indentation to show nesting of routes under a common prefix. This also shows the request methods that each route accepts. If there are any trivially overlapped routes, the appends are asterisk to the method name for which the routes are overlapped.

Eq TrasaErr Source #
Instance details Defined in Trasa.Error Methods (==) :: TrasaErr -> TrasaErr -> Bool # (/=) :: TrasaErr -> TrasaErr -> Bool #
Ord TrasaErr Source #
Instance details Defined in Trasa.Error Methods compare :: TrasaErr -> TrasaErr -> Ordering # (<) :: TrasaErr -> TrasaErr -> Bool # (<=) :: TrasaErr -> TrasaErr -> Bool # (>) :: TrasaErr -> TrasaErr -> Bool # (>=) :: TrasaErr -> TrasaErr -> Bool # max :: TrasaErr -> TrasaErr -> TrasaErr # min :: TrasaErr -> TrasaErr -> TrasaErr #
Show TrasaErr Source #
Instance details Defined in Trasa.Error Methods showsPrec :: Int -> TrasaErr -> ShowS # show :: TrasaErr -> String # showList :: [TrasaErr] -> ShowS #
Exception TrasaErr Source #
Instance details Defined in Trasa.Error Methods toException :: TrasaErr -> SomeException # fromException :: SomeException -> Maybe TrasaErr # displayException :: TrasaErr -> String #

TrasaErr
Fields trasaErrStatus :: Status trasaErrBody :: ByteString

Meta
Fields metaPath :: !(Path capCodec caps) metaQuery :: !(Rec (Query qryCodec) qrys) metaRequestBody :: !(RequestBody reqCodec req) metaResponseBody :: !(ResponseBody respCodec resp) metaMethod :: !Method

Types

Existential

Request Types

Method

Queries

Url

Errors

Using Routes

Defining Routes

Path

Query

Request Body

Response Body

Many

Meta

Codecs

Converting Codecs

Type Class based Codecs

Argument Currying

Helpers