/usr/share/doc/libghc-servant-server-doc/html/Servant-Server-Experimental-Auth.html is in libghc-servant-server-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 | <!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.Server.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-Server-Experimental-Auth.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Servant-Server-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-server-0.8.1: A family of combinators for defining webservices APIs and serving them</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.Server.Experimental.Auth</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">General Auth</a></li><li><a href="#section.orphans">Orphan instances</a></li></ul></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">type family</span> <a href="#t:AuthServerData">AuthServerData</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"><span class="keyword">newtype</span> <a href="#t:AuthHandler">AuthHandler</a> r usr = <a href="#v:AuthHandler">AuthHandler</a> {<ul class="subs"><li><a href="#v:unAuthHandler">unAuthHandler</a> :: r -> <a href="Servant-Server-Internal-ServantErr.html#t:Handler">Handler</a> usr</li></ul>}</li><li class="src short"><a href="#v:mkAuthHandler">mkAuthHandler</a> :: (r -> <a href="Servant-Server-Internal-ServantErr.html#t:Handler">Handler</a> usr) -> <a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr</li></ul></div><div id="interface"><h1 id="g:1">General Auth</h1><div class="top"><p class="src"><span class="keyword">type family</span> <a id="t:AuthServerData" class="def">AuthServerData</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-Server-Experimental-Auth.html#AuthServerData" class="link">Source</a> <a href="#t:AuthServerData" class="selflink">#</a></p><div class="doc"><p>Specify the type of data returned after we've authenticated a request.
quite often this is some <code>User</code> datatype.</p><p>NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</p></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a id="t:AuthHandler" class="def">AuthHandler</a> r usr <a href="src/Servant-Server-Experimental-Auth.html#AuthHandler" class="link">Source</a> <a href="#t:AuthHandler" class="selflink">#</a></p><div class="doc"><p>Handlers for AuthProtected resources</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:AuthHandler" class="def">AuthHandler</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:unAuthHandler" class="def">unAuthHandler</a> :: r -> <a href="Servant-Server-Internal-ServantErr.html#t:Handler">Handler</a> usr</dfn><div class="doc empty"> </div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:AuthHandler" class="caption collapser" onclick="toggleSection('i:AuthHandler')">Instances</p><div id="section.i:AuthHandler" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:AuthHandler:Generic:1" class="instance expander" onclick="toggleSection('i:id:AuthHandler:Generic:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Generic">Generic</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr)</span> <a href="src/Servant-Server-Experimental-Auth.html#line-47" class="link">Source</a> <a href="#t:AuthHandler" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:AuthHandler:Generic:1" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Rep">Rep</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr) :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="#t:Rep" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:from">from</a> :: <a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Rep">Rep</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr) x <a href="#v:from" class="selflink">#</a></p><p class="src"><a href="#v:to">to</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Rep">Rep</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr) x -> <a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr <a href="#v:to" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:AuthHandler:Rep:2" class="instance expander" onclick="toggleSection('i:id:AuthHandler:Rep:2')"></span> <span class="keyword">type</span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Rep">Rep</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr)</span> <a href="src/Servant-Server-Experimental-Auth.html#line-45" class="link">Source</a> <a href="#t:AuthHandler" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:AuthHandler:Rep:2" class="inst-details hide"><div class="src"><span class="keyword">type</span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Rep">Rep</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr) = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:D1">D1</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:MetaData">MetaData</a> "AuthHandler" "Servant.Server.Experimental.Auth" "servant-server-0.8.1-2LHkbrY1twbE52cPHHmPEW" <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#v:True">True</a>) (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:C1">C1</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:MetaCons">MetaCons</a> "AuthHandler" <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:PrefixI">PrefixI</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#v:True">True</a>) (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:S1">S1</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:MetaSel">MetaSel</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#v:Just">Just</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-TypeLits.html#t:Symbol">Symbol</a> "unAuthHandler") <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:NoSourceUnpackedness">NoSourceUnpackedness</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:NoSourceStrictness">NoSourceStrictness</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#v:DecidedLazy">DecidedLazy</a>) (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Generics.html#t:Rec0">Rec0</a> (r -> <a href="Servant-Server-Internal-ServantErr.html#t:Handler">Handler</a> usr))))</div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:mkAuthHandler" class="def">mkAuthHandler</a> :: (r -> <a href="Servant-Server-Internal-ServantErr.html#t:Handler">Handler</a> usr) -> <a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> r usr <a href="src/Servant-Server-Experimental-Auth.html#mkAuthHandler" class="link">Source</a> <a href="#v:mkAuthHandler" class="selflink">#</a></p><div class="doc"><p>NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</p></div></div><h1>Orphan instances</h1><div id="section.orphans" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:o:ic:HasServer:HasServer:1" class="instance expander" onclick="toggleSection('i:o:ic:HasServer:HasServer:1')"></span> (<a href="Servant-Server-Internal.html#t:HasServer">HasServer</a> k1 api context, <a href="Servant-Server-Internal-Context.html#t:HasContextEntry">HasContextEntry</a> context (<a href="Servant-Server-Experimental-Auth.html#t:AuthHandler">AuthHandler</a> <a href="file:///usr/share/doc/libghc-wai-doc/html/Network-Wai.html#t:Request">Request</a> (<a href="Servant-Server-Experimental-Auth.html#t:AuthServerData">AuthServerData</a> (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Experimental-Auth.html#t:AuthProtect">AuthProtect</a> k tag)))) => <a href="Servant-Server-Internal.html#t:HasServer">HasServer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Sub.html#t::-62-">(:>)</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> k1 (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Experimental-Auth.html#t:AuthProtect">AuthProtect</a> k tag) api) context</span> <a href="src/Servant-Server-Experimental-Auth.html#line-54" class="link">Source</a> <a href="#v:-36-fHasServerTYPE:-62-context" class="selflink">#</a></td><td class="doc"><p>Known orphan instance.</p></td></tr><tr><td colspan="2"><div id="section.i:o:ic:HasServer:HasServer:1" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Servant-Server-Internal.html#t:ServerT">ServerT</a> (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Sub.html#t::-62-">(:>)</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> k1 (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Experimental-Auth.html#t:AuthProtect">AuthProtect</a> k tag) api) (context :: <a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Sub.html#t::-62-">(:>)</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> k1 (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Experimental-Auth.html#t:AuthProtect">AuthProtect</a> k tag) api) (m :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</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-Server-Internal.html#ServerT" class="link">Source</a> <a href="#t:ServerT" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:route">route</a> :: <a href="Servant.html#t:Proxy">Proxy</a> ((<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Sub.html#t::-62-">:></a> k1) (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Experimental-Auth.html#t:AuthProtect">AuthProtect</a> k tag) api) context -> <a href="Servant-Server-Internal-Context.html#t:Context">Context</a> context -> <a href="Servant-Server-Internal-RoutingApplication.html#t:Delayed">Delayed</a> env (<a href="Servant-Server-Internal.html#t:Server">Server</a> ((<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Sub.html#t::-62-">:></a> k1) (<a href="file:///usr/share/doc/libghc-servant-doc/html/Servant-API-Experimental-Auth.html#t:AuthProtect">AuthProtect</a> k tag) api) context) -> <a href="Servant-Server-Internal-Router.html#t:Router">Router</a> env <a href="src/Servant-Server-Internal.html#route" class="link">Source</a> <a href="#v:route" class="selflink">#</a></p></div></div></td></tr></table></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>
|