libghc-yesod-core-doc 0.10.2.1-1 / usr / share / doc / libghc-yesod-core-doc / html / Yesod-Request.html

This file is indexed.

/usr/share/doc/libghc-yesod-core-doc/html/Yesod-Request.html is in libghc-yesod-core-doc 0.10.2.1-1.

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
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<!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>Yesod.Request</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Yesod-Request.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Yesod-Request.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">yesod-core-0.10.2.1: Creation of type-safe, RESTful web applications.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Yesod.Request</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Request datatype
</a></li><li><a href="#g:2">Convenience functions
</a></li><li><a href="#g:3">Lookup parameters
</a><ul><li><a href="#g:4">Multi-lookup
</a></li></ul></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Provides a parsed version of the raw <code><a href="W.html#t:Request">Request</a></code> data.
</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">type</span> <a href="#t:RequestBodyContents">RequestBodyContents</a> = ([(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)], [(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="Yesod-Request.html#t:FileInfo">FileInfo</a>)])</li><li class="src short"><span class="keyword">data</span>  <a href="#t:Request">Request</a>  = <a href="#v:Request">Request</a> {<ul class="subs"><li><a href="#v:reqGetParams">reqGetParams</a> :: [(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)]</li><li><a href="#v:reqCookies">reqCookies</a> :: [(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)]</li><li><a href="#v:reqWaiRequest">reqWaiRequest</a> :: <a href="/usr/share/doc/libghc-wai-doc/html/Network-Wai.html#t:Request">Request</a></li><li><a href="#v:reqLangs">reqLangs</a> :: [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]</li><li><a href="#v:reqNonce">reqNonce</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></li></ul>}</li><li class="src short"><span class="keyword">data</span>  <a href="#t:FileInfo">FileInfo</a>  = <a href="#v:FileInfo">FileInfo</a> {<ul class="subs"><li><a href="#v:fileName">fileName</a> :: <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></li><li><a href="#v:fileContentType">fileContentType</a> :: <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></li><li><a href="#v:fileContent">fileContent</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li></ul>}</li><li class="src short"><a href="#v:languages">languages</a> ::  <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]</li><li class="src short"><a href="#v:lookupGetParam">lookupGetParam</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)</li><li class="src short"><a href="#v:lookupPostParam">lookupPostParam</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)</li><li class="src short"><a href="#v:lookupCookie">lookupCookie</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)</li><li class="src short"><a href="#v:lookupFile">lookupFile</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Yesod-Request.html#t:FileInfo">FileInfo</a>)</li><li class="src short"><a href="#v:lookupGetParams">lookupGetParams</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]</li><li class="src short"><a href="#v:lookupPostParams">lookupPostParams</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]</li><li class="src short"><a href="#v:lookupCookies">lookupCookies</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]</li><li class="src short"><a href="#v:lookupFiles">lookupFiles</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="Yesod-Request.html#t:FileInfo">FileInfo</a>]</li></ul></div><div id="interface"><h1 id="g:1">Request datatype
</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:RequestBodyContents" class="def">RequestBodyContents</a> = ([(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)], [(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="Yesod-Request.html#t:FileInfo">FileInfo</a>)])<a href="src/Yesod-Internal-Request.html#RequestBodyContents" class="link">Source</a></p><div class="doc"><p>A tuple containing both the POST parameters and submitted files.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span>  <a name="t:Request" class="def">Request</a>  <a href="src/Yesod-Internal-Request.html#Request" class="link">Source</a></p><div class="doc"><p>The parsed request information.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Request" class="def">Request</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:reqGetParams" class="def">reqGetParams</a> :: [(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:reqCookies" class="def">reqCookies</a> :: [(<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>, <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)]</dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:reqWaiRequest" class="def">reqWaiRequest</a> :: <a href="/usr/share/doc/libghc-wai-doc/html/Network-Wai.html#t:Request">Request</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:reqLangs" class="def">reqLangs</a> :: [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]</dt><dd class="doc"><p>Languages which the client supports.
</p></dd><dt class="src"><a name="v:reqNonce" class="def">reqNonce</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></dt><dd class="doc"><p>A random, session-specific nonce used to prevent CSRF attacks.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span>  <a name="t:FileInfo" class="def">FileInfo</a>  <a href="src/Yesod-Internal-Request.html#FileInfo" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:FileInfo" class="def">FileInfo</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:fileName" class="def">fileName</a> :: <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:fileContentType" class="def">fileContentType</a> :: <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></dt><dd class="doc empty">&nbsp;</dd><dt class="src"><a name="v:fileContent" class="def">fileContent</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:FileInfo" class="caption collapser" onclick="toggleSection('i:FileInfo')">Instances</p><div id="section.i:FileInfo" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Yesod-Request.html#t:FileInfo">FileInfo</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Yesod-Request.html#t:FileInfo">FileInfo</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><h1 id="g:2">Convenience functions
</h1><div class="top"><p class="src"><a name="v:languages" class="def">languages</a> ::  <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]<a href="src/Yesod-Request.html#languages" class="link">Source</a></p><div class="doc"><p>Get the list of supported languages supplied by the user.
</p><p>Languages are determined based on the following three (in descending order
 of preference):
</p><ul><li> The _LANG get parameter.
</li><li> The _LANG cookie.
</li><li> The _LANG user session variable.
</li><li> Accept-Language HTTP header.
</li></ul><p>This is handled by parseWaiRequest (not exposed).
</p></div></div><h1 id="g:3">Lookup parameters
</h1><div class="top"><p class="src"><a name="v:lookupGetParam" class="def">lookupGetParam</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)<a href="src/Yesod-Request.html#lookupGetParam" class="link">Source</a></p><div class="doc"><p>Lookup for GET parameters.
</p></div></div><div class="top"><p class="src"><a name="v:lookupPostParam" class="def">lookupPostParam</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)<a href="src/Yesod-Request.html#lookupPostParam" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:lookupCookie" class="def">lookupCookie</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>)<a href="src/Yesod-Request.html#lookupCookie" class="link">Source</a></p><div class="doc"><p>Lookup for cookie data.
</p></div></div><div class="top"><p class="src"><a name="v:lookupFile" class="def">lookupFile</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Yesod-Request.html#t:FileInfo">FileInfo</a>)<a href="src/Yesod-Request.html#lookupFile" class="link">Source</a></p><div class="doc"><p>Lookup for POSTed files.
</p></div></div><h2 id="g:4">Multi-lookup
</h2><div class="top"><p class="src"><a name="v:lookupGetParams" class="def">lookupGetParams</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]<a href="src/Yesod-Request.html#lookupGetParams" class="link">Source</a></p><div class="doc"><p>Lookup for GET parameters.
</p></div></div><div class="top"><p class="src"><a name="v:lookupPostParams" class="def">lookupPostParams</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]<a href="src/Yesod-Request.html#lookupPostParams" class="link">Source</a></p><div class="doc"><p>Lookup for POST parameters.
</p></div></div><div class="top"><p class="src"><a name="v:lookupCookies" class="def">lookupCookies</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a>]<a href="src/Yesod-Request.html#lookupCookies" class="link">Source</a></p><div class="doc"><p>Lookup for cookie data.
</p></div></div><div class="top"><p class="src"><a name="v:lookupFiles" class="def">lookupFiles</a> ::  <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="Yesod-Handler.html#t:GHandler">GHandler</a> s m [<a href="Yesod-Request.html#t:FileInfo">FileInfo</a>]<a href="src/Yesod-Request.html#lookupFiles" class="link">Source</a></p><div class="doc"><p>Lookup for POSTed files.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>

APT Browse - Built by Thomas Orozco.