/usr/share/doc/libghc-yesod-static-doc/html/Yesod-EmbeddedStatic-Types.html

<!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.EmbeddedStatic.Types</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-EmbeddedStatic-Types.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Yesod-EmbeddedStatic-Types.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-static-1.5.0.3: Static file serving subsite for Yesod Web Framework.</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>Haskell98</td></tr></table><p class="caption">Yesod.EmbeddedStatic.Types</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Entry</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</span> <a href="#t:Location">Location</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:Generator">Generator</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Q">Q</a> [<a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:Entry">Entry</a></li><li class="src short"><a href="#v:ebHaskellName">ebHaskellName</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a></li><li class="src short"><a href="#v:ebLocation">ebLocation</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="Yesod-EmbeddedStatic-Types.html#t:Location">Location</a></li><li class="src short"><a href="#v:ebMimeType">ebMimeType</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/libghc-mime-types-doc/html/Network-Mime.html#t:MimeType">MimeType</a></li><li class="src short"><a href="#v:ebProductionContent">ebProductionContent</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:ebDevelReload">ebDevelReload</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li><li class="src short"><a href="#v:ebDevelExtraFiles">ebDevelExtraFiles</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Location" class="def">Location</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> <a href="src/Yesod-EmbeddedStatic-Types.html#Location" class="link">Source</a></p><div class="doc"><p>A location is a relative path within the static subsite at which resource(s) are made available.
 The location can include slashes to simulate directories but must not start or end with a slash.</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Generator" class="def">Generator</a> = <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Q">Q</a> [<a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a>] <a href="src/Yesod-EmbeddedStatic-Types.html#Generator" class="link">Source</a></p><div class="doc"><p>An embedded generator is executed at compile time to produce the entries to embed.</p></div></div><h2 id="g:1">Entry</h2><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Entry" class="def">Entry</a> <a href="src/Yesod-EmbeddedStatic-Types.html#Entry" class="link">Source</a></p><div class="doc"><p>A single resource embedded into the executable at compile time.</p><p>This data type is a settings type.  For more information, see
 <a href="http://www.yesodweb.com/book/settings-types">http://www.yesodweb.com/book/settings-types</a>.</p></div><div class="subs instances"><p id="control.i:Entry" class="caption collapser" onclick="toggleSection('i:Entry')">Instances</p><div id="section.i:Entry" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/libghc-data-default-doc/html/Data-Default.html#t:Default">Default</a> <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a></span> <a href="src/Yesod-EmbeddedStatic-Types.html#line-57" class="link">Source</a></td><td class="doc"><p>When using <code><a href="file:///usr/share/doc/libghc-data-default-doc/html/Data-Default.html#v:def">def</a></code>, you must fill in at least <code><a href="Yesod-EmbeddedStatic-Types.html#v:ebLocation">ebLocation</a></code>.</p></td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:ebHaskellName" class="def">ebHaskellName</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> <a href="src/Yesod-EmbeddedStatic-Types.html#ebHaskellName" class="link">Source</a></p><div class="doc"><p>An optional haskell name. If the name is present, a variable
   of type <code>Route <code><a href="Yesod-EmbeddedStatic.html#v:EmbeddedStatic">EmbeddedStatic</a></code></code> with the
   given name will be created which points to this resource.</p></div></div><div class="top"><p class="src"><a name="v:ebLocation" class="def">ebLocation</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="Yesod-EmbeddedStatic-Types.html#t:Location">Location</a> <a href="src/Yesod-EmbeddedStatic-Types.html#ebLocation" class="link">Source</a></p><div class="doc"><p>The location to serve the resource from.</p></div></div><div class="top"><p class="src"><a name="v:ebMimeType" class="def">ebMimeType</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/libghc-mime-types-doc/html/Network-Mime.html#t:MimeType">MimeType</a> <a href="src/Yesod-EmbeddedStatic-Types.html#ebMimeType" class="link">Source</a></p><div class="doc"><p>The mime type of the resource.</p></div></div><div class="top"><p class="src"><a name="v:ebProductionContent" class="def">ebProductionContent</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> <a href="src/Yesod-EmbeddedStatic-Types.html#ebProductionContent" class="link">Source</a></p><div class="doc"><p>If the development argument to <code><a href="Yesod-EmbeddedStatic.html#v:mkEmbeddedStatic">mkEmbeddedStatic</a></code> is False,
 then at compile time this action will be executed to load the content.
 During development, this action will not be executed.</p></div></div><div class="top"><p class="src"><a name="v:ebDevelReload" class="def">ebDevelReload</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Yesod-EmbeddedStatic-Types.html#ebDevelReload" class="link">Source</a></p><div class="doc"><p>This must be a template haskell expression of type <code>IO <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></code></code>.
 If the development argument to <code><a href="Yesod-EmbeddedStatic.html#v:mkEmbeddedStatic">mkEmbeddedStatic</a></code> is True,
 this action is executed on every request to compute the content.  Most of the
 time, <code><a href="Yesod-EmbeddedStatic-Types.html#v:ebProductionContent">ebProductionContent</a></code> and <code><a href="Yesod-EmbeddedStatic-Types.html#v:ebDevelReload">ebDevelReload</a></code> should be the same action but
 occasionally you might want additional processing inside the <code><a href="Yesod-EmbeddedStatic-Types.html#v:ebProductionContent">ebProductionContent</a></code>
 function like javascript/css minification to only happen when building for production.</p></div></div><div class="top"><p class="src"><a name="v:ebDevelExtraFiles" class="def">ebDevelExtraFiles</a> :: <a href="Yesod-EmbeddedStatic-Types.html#t:Entry">Entry</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Yesod-EmbeddedStatic-Types.html#ebDevelExtraFiles" class="link">Source</a></p><div class="doc"><p>Occasionally, during development an entry needs extra files/resources available
   that are not present during production (for example, image files that are embedded
   into the CSS at production but left unembedded during development).  If present,
   <code>ebDevelExtraFiles</code> must be a template haskell expression of type
   <code>[<code><a href="T.html#v:Text">Text</a></code>] -&gt; IO (Maybe (<code><a href="file:///usr/share/doc/libghc-mime-types-doc/html/Network-Mime.html#t:MimeType">MimeType</a></code>, <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></code>))</code>.  That is, a function
   taking as input the list of path pieces and optionally returning a mime type
   and content.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
libghc-yesod-static-doc 1.5.0.3-1build2 / usr / share / doc / libghc-yesod-static-doc / html / Yesod-EmbeddedStatic-Types.html
