Trasa.Core

Contents

• 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

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 u (a :: u -> *) (b :: [u]) :: forall u. (u -> *) -> [u] -> * where
  • RNil :: Rec u a ([] u)
  • (:&) :: Rec u a ((:) u 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
• newtype CaptureDecoding a = CaptureDecoding {
  • appCaptureDecoding :: Text -> Maybe a
  }
• class HasCaptureDecoding capStrategy where
• data CaptureCodec a = CaptureCodec {
  • captureCodecEncode :: a -> Text
  • captureCodecDecode :: Text -> Maybe a
  }
• class HasCaptureCodec capStrategy where
• data BodyEncoding a = BodyEncoding {
  • bodyEncodingNames :: NonEmpty MediaType
  • bodyEncodingFunction :: a -> ByteString
  }
• class HasBodyEncoding bodyStrategy where
• data BodyDecoding a = BodyDecoding {
  • bodyDecodingNames :: NonEmpty MediaType
  • bodyDecodingFunction :: ByteString -> Either Text a
  }
• class HasBodyDecoding bodyStrategy where
• data BodyCodec a = BodyCodec {
  • bodyCodecNames :: NonEmpty MediaType
  • bodyCodecEncode :: a -> ByteString
  • bodyCodecDecode :: ByteString -> Either Text a
  }
• class HasBodyCodec bodyStrategy where
• 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

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

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

Helpers