Trasa.Core

Contents

• Types
  • Existential
• Queries
• Url
• Using Routes
• Defining Routes
  • Path
  • Request Body
  • Response Body
  • Query
• Converting Route Metadata
• Converting Codecs
• Errors
• Argument Currying
• Random Stuff
• Show/Read Codecs

Synopsis

• data Bodiedness
  • = Body a
  • | Bodyless
• 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
• newtype ResponseBody rpf response = ResponseBody {
  • getResponseBody :: rpf response
  }
• data RequestBody :: (Type -> Type) -> Bodiedness -> Type where
  • RequestBodyPresent :: f a -> RequestBody f (Body a)
  • RequestBodyAbsent :: RequestBody f Bodyless
• 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 b :: forall u. (u -> *) -> [u] -> * where
  • RNil :: Rec u a ([] u)
  • (:&) :: Rec u a ((:) u r rs)
• data BodyCodec a = BodyCodec {
  • bodyCodecNames :: NonEmpty Text
  • bodyCodecEncode :: a -> ByteString
  • bodyCodecDecode :: ByteString -> Either Text a
  }
• data BodyDecoding a = BodyDecoding {
  • bodyDecodingNames :: NonEmpty Text
  • bodyDecodingFunction :: ByteString -> Either Text a
  }
• data BodyEncoding a = BodyEncoding {
  • bodyEncodingNames :: NonEmpty Text
  • bodyEncodingFunction :: a -> ByteString
  }
• newtype Many f a = Many {
  • getMany :: NonEmpty (f a)
  }
• data CaptureCodec a = CaptureCodec {
  • captureCodecEncode :: a -> Text
  • captureCodecDecode :: Text -> Maybe a
  }
• newtype CaptureEncoding a = CaptureEncoding {
  • appCaptureEncoding :: a -> Text
  }
• newtype CaptureDecoding a = CaptureDecoding {
  • appCaptureDecoding :: Text -> Maybe a
  }
• data Content = Content {
  • contentType :: Text
  • contentData :: ByteString
  }
• newtype QueryString = QueryString {
  • unQueryString :: HashMap Text QueryParam
  }
• data Url = Url {
  • urlPath :: ![Text]
  • urlQueryString :: !QueryString
  }
• data Payload = Payload {
  • payloadUrl :: !Url
  • payloadContent :: !(Maybe Content)
  • payloadAccepts :: !(NonEmpty Text)
  }
• data TrasaErr = TrasaErr {
  • trasaErrStatus :: Status
  • trasaErrBody :: ByteString
  }
• 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
• encodeQuery :: QueryString -> Query
• decodeQuery :: Query -> QueryString
• encodeUrl :: Url -> Text
• decodeUrl :: Text -> Url
• prepareWith :: (forall caps qry req resp. route caps qry req resp -> Path pf caps) -> (forall caps qry req resp. route caps qry req resp -> Rec (Query qf) qry) -> (forall caps qry req resp. route caps qry req resp -> RequestBody rqf req) -> route captures query request response -> Arguments captures query request (Prepared route response)
• dispatchWith :: forall route m. Applicative m => (forall caps qrys req resp. route caps qrys req resp -> Rec (Query CaptureDecoding) qrys) -> (forall caps qrys req resp. route caps qrys req resp -> RequestBody (Many BodyDecoding) req) -> (forall caps qrys req resp. route caps qrys req resp -> ResponseBody (Many BodyEncoding) resp) -> (forall caps qrys req resp. route caps qrys req resp -> Rec Identity caps -> Rec Parameter qrys -> RequestBody Identity req -> m resp) -> Router route -> Text -> [Text] -> Url -> Maybe Content -> m (Either TrasaErr Content)
• parseWith :: forall route. (forall caps qrys req resp. route caps qrys req resp -> Rec (Query CaptureDecoding) qrys) -> (forall caps qrys req resp. route caps qrys req resp -> RequestBody (Many BodyDecoding) req) -> Router route -> Text -> Url -> Maybe Content -> Either TrasaErr (Concealed route)
• linkWith :: forall route response. (forall caps qrys req resp. route caps qrys req resp -> Path CaptureEncoding caps) -> (forall caps qrys req resp. route caps qrys req resp -> Rec (Query CaptureEncoding) qrys) -> Prepared route response -> Url
• payloadWith :: forall route response. (forall caps qrys req resp. route caps qrys req resp -> Path CaptureEncoding caps) -> (forall caps qrys req resp. route caps qrys req resp -> Rec (Query CaptureEncoding) qrys) -> (forall caps qrys req resp. route caps qrys req resp -> RequestBody (Many BodyEncoding) req) -> (forall caps qrys req resp. route caps qrys req resp -> ResponseBody (Many BodyDecoding) resp) -> Prepared route response -> Payload
• requestWith :: Functor m => (forall caps querys req resp. route caps querys req resp -> Text) -> (forall caps querys req resp. route caps querys req resp -> Path CaptureEncoding caps) -> (forall caps querys req resp. route caps querys req resp -> Rec (Query CaptureEncoding) querys) -> (forall caps querys req resp. route caps querys req resp -> RequestBody (Many BodyEncoding) req) -> (forall caps querys req resp. route caps querys req resp -> ResponseBody (Many BodyDecoding) resp) -> (Text -> Url -> Maybe Content -> [Text] -> m (Either TrasaErr Content)) -> Prepared route response -> m (Either TrasaErr response)
• routerWith :: (forall caps querys req resp. route caps querys req resp -> Text) -> (forall caps querys req resp. route caps querys req resp -> Path CaptureDecoding caps) -> [Constructed route] -> Router route
• handler :: forall captures querys request x. Rec Identity captures -> Rec Parameter querys -> RequestBody Identity request -> Arguments captures querys request x -> x
• 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
• appendPath :: Path f as -> Path f bs -> Path f (as ++ bs)
• body :: rqf req -> RequestBody rqf (Body req)
• bodyless :: RequestBody rqf Bodyless
• resp :: rpf resp -> ResponseBody rpf resp
• 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
• one :: f a -> Many f a
• mapMany :: (forall x. f x -> g x) -> Many f a -> Many g a
• mapPath :: (forall x. cf x -> cf' x) -> Path cf ps -> Path cf' ps
• mapRequestBody :: (forall x. rqf x -> rqf' x) -> RequestBody rqf request -> RequestBody rqf' request
• mapResponseBody :: (forall x. rpf x -> rpf' x) -> ResponseBody rpf request -> ResponseBody rpf' request
• mapConstructed :: (forall caps qrys req resp. sub caps qrys req resp -> route cap qrys req resp) -> Constructed sub -> Constructed route
• bodyCodecToBodyEncoding :: BodyCodec a -> BodyEncoding a
• bodyCodecToBodyDecoding :: BodyCodec a -> BodyDecoding a
• captureCodecToCaptureEncoding :: CaptureCodec a -> CaptureEncoding a
• captureCodecToCaptureDecoding :: CaptureCodec a -> CaptureDecoding a
• status :: Status -> TrasaErr
• type family ParamBase (param :: Param) :: Type where ...
• type family Arguments (pieces :: [Type]) (querys :: [Param]) (body :: Bodiedness) (result :: Type) :: Type where ...
• conceal :: Prepared route response -> Concealed route
• encodeRequestBody :: RequestBody (Many BodyEncoding) request -> RequestBody Identity request -> Maybe Content
• decodeResponseBody :: ResponseBody (Many BodyDecoding) response -> Content -> Maybe response
• prettyRouter :: Router route -> String
• showReadBodyCodec :: (Show a, Read a) => BodyCodec a
• showReadCaptureCodec :: (Show a, Read a) => CaptureCodec a

Types

Existential

Queries

Url

Using Routes

Defining Routes

Path

Request Body

Response Body

Query

Converting Route Metadata

Converting Codecs

Errors

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

Random Stuff

Show/Read Codecs