/usr/share/doc/libghc-servant-client-doc/html/Servant-Client-Experimental-Auth.html is in libghc-servant-client-doc 0.8.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Servant.Client.Experimental.Auth</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Servant-Client-Experimental-Auth.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Servant-Client-Experimental-Auth.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">servant-client-0.8.1: automatical derivation of querying functions for servant webservices</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Servant.Client.Experimental.Auth</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Authentication for clients</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">newtype</span> <a href="#t:AuthenticateReq">AuthenticateReq</a> a = <a href="#v:AuthenticateReq">AuthenticateReq</a> {<ul class="subs"><li><a href="#v:unAuthReq">unAuthReq</a> :: (<a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a, <a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a -> <a href="Servant-Common-Req.html#t:Req">Req</a> -> <a href="Servant-Common-Req.html#t:Req">Req</a>)</li></ul>}</li><li class="src short"><span class="keyword">type family</span> <a href="#t:AuthClientData">AuthClientData</a> a :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a></li><li class="src short"><a href="#v:mkAuthenticateReq">mkAuthenticateReq</a> :: <a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a -> (<a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a -> <a href="Servant-Common-Req.html#t:Req">Req</a> -> <a href="Servant-Common-Req.html#t:Req">Req</a>) -> <a href="Servant-Client-Experimental-Auth.html#t:AuthenticateReq">AuthenticateReq</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a id="t:AuthenticateReq" class="def">AuthenticateReq</a> a <a href="src/Servant-Client-Experimental-Auth.html#AuthenticateReq" class="link">Source</a> <a href="#t:AuthenticateReq" class="selflink">#</a></p><div class="doc"><p>For better type inference and to avoid usage of a data family, we newtype
wrap the combination of some <code><a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a></code> and a function to add authentication
data to a request</p><p>NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:AuthenticateReq" class="def">AuthenticateReq</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:unAuthReq" class="def">unAuthReq</a> :: (<a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a, <a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a -> <a href="Servant-Common-Req.html#t:Req">Req</a> -> <a href="Servant-Common-Req.html#t:Req">Req</a>)</dfn><div class="doc empty"> </div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">type family</span> <a id="t:AuthClientData" class="def">AuthClientData</a> a :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Servant-Client-Experimental-Auth.html#AuthClientData" class="link">Source</a> <a href="#t:AuthClientData" class="selflink">#</a></p><div class="doc"><p>For a resource protected by authentication (e.g. AuthProtect), we need
to provide the client with some data used to add authentication data
to a request</p><p>NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</p></div></div><div class="top"><p class="src"><a id="v:mkAuthenticateReq" class="def">mkAuthenticateReq</a> :: <a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a -> (<a href="Servant-Client-Experimental-Auth.html#t:AuthClientData">AuthClientData</a> a -> <a href="Servant-Common-Req.html#t:Req">Req</a> -> <a href="Servant-Common-Req.html#t:Req">Req</a>) -> <a href="Servant-Client-Experimental-Auth.html#t:AuthenticateReq">AuthenticateReq</a> a <a href="src/Servant-Client-Experimental-Auth.html#mkAuthenticateReq" class="link">Source</a> <a href="#v:mkAuthenticateReq" class="selflink">#</a></p><div class="doc"><p>Handy helper to avoid wrapping datatypes in tuples everywhere.</p><p>NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
|