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

Remove Monoid instance of Link and simplify Utils.Links documentation

Browse source
This commit is contained in:
Christian Marie 2015-01-29 15:03:33 +11:00
parent c1ab495a7a
commit 3a4471f211
1 changed files with 4 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/Servant/Utils/Links.hs
View file

@ -28,9 +28,9 @@
-- 'safeLink'. The first argument to 'safeLink' is a type representing the -- 'safeLink'. The first argument to 'safeLink' is a type representing the
-- endpoint you would like to point to. This will need to end in a verb like -- endpoint you would like to point to. This will need to end in a verb like
-- Get, or Post. The second argument is the API in which you would like to -- Get, or Post. The second argument is the API in which you would like to
-- ensure the endpoint is within. Further arguments may or may not be required -- ensure the endpoint is within. Further arguments be required depending on
-- depending on the type of the endpoint. If everything lines up you will get a -- the type of the endpoint. If everything lines up you will get a 'URI' out
-- 'URI' out the other end. -- the other end.
-- --
-- You may omit 'QueryParam's and the like should you not want to provide them, -- You may omit 'QueryParam's and the like should you not want to provide them,
-- but types which form part of the URL path like 'Capture' must be included. -- but types which form part of the URL path like 'Capture' must be included.
@ -188,11 +188,6 @@ addMatrixParam param l = l { _segments = f (_segments l) }
ArrayElemParam k v -> seg <> ";" <> k <> "[]=" <> escape (unpack v) ArrayElemParam k v -> seg <> ";" <> k <> "[]=" <> escape (unpack v)
FlagParam k -> seg <> ";" <> k FlagParam k -> seg <> ";" <> k
instance Monoid Link where
mempty = Link mempty mempty
mappend (Link a1 b1) (Link a2 b2) =
Link (a1 <> a2) (b1 <> b2)
linkURI :: Link -> URI linkURI :: Link -> URI
linkURI (Link segments q_params) = linkURI (Link segments q_params) =
URI mempty -- No scheme (relative) URI mempty -- No scheme (relative)
@ -221,7 +216,7 @@ safeLink
=> Proxy endpoint -- ^ The API endpoint you would like to point to => Proxy endpoint -- ^ The API endpoint you would like to point to
-> Proxy api -- ^ The whole API that you this endpoint is a part of -> Proxy api -- ^ The whole API that you this endpoint is a part of
-> MkLink endpoint -> MkLink endpoint
safeLink endpoint _ = link endpoint mempty safeLink endpoint _ = link endpoint (Link mempty mempty)
-- | Construct a link for an endpoint. -- | Construct a link for an endpoint.
class HasLink endpoint where class HasLink endpoint where