eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

some more documentation, code cleanup + changelog entry

Browse source
This commit is contained in:
Alp Mestanogullari 2015-03-11 11:46:35 +01:00
parent 6909b54367
commit 7a83952bad
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -1,5 +1,6 @@
0.3 0.3
--- ---
* Add a `Canonicalize` type family that distributes all `:>`s inside `:<|>`s to get to the canonical type of an API -- which is then used in all other packages to avoid weird handler types in *servant-server*.
* Multiple content-type/accept support for all the relevant combinators * Multiple content-type/accept support for all the relevant combinators
* Provide *JSON*, *PlainText*, *OctetStream* and *FormUrlEncoded* content types out of the box * Provide *JSON*, *PlainText*, *OctetStream* and *FormUrlEncoded* content types out of the box
* Type-safe link generation to API endpoints * Type-safe link generation to API endpoints

9
src/Servant/API.hs
View file

@ -80,7 +80,12 @@ import Servant.Utils.Links (HasLink (..), IsElem, IsElem',
-- | Turn an API type into its canonical form. -- | Turn an API type into its canonical form.
-- --
-- The canonical form is defined and will basically turn: -- The canonical form of an API type is basically the all-flattened form
-- of the original type. More formally, it takes a type as input and hands you
-- back an /equivalent/ type formed of toplevel `:<|>`-separated chains of `:>`s,
-- i.e with all `:>`s distributed inside the `:<|>`s.
--
-- It basically turns:
-- --
-- > "hello" :> (Get Hello :<|> ReqBody Hello :> Put Hello) -- > "hello" :> (Get Hello :<|> ReqBody Hello :> Put Hello)
-- --
@ -101,5 +106,5 @@ type family Redex a b c :: * where
Redex a a first = Canonicalize first :> a Redex a a first = Canonicalize first :> a
Redex a b first = Canonicalize (first :> b) Redex a b first = Canonicalize (first :> b)
canonicalize :: Canonicalize layout ~ t => Proxy layout -> Proxy t canonicalize :: Proxy layout -> Proxy (Canonicalize layout)
canonicalize Proxy = Proxy canonicalize Proxy = Proxy