-
Notifications
You must be signed in to change notification settings - Fork 272
/
Control-Lens-Internal-FieldTH.html
5 lines (5 loc) · 11.8 KB
/
Control-Lens-Internal-FieldTH.html
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>Control.Lens.Internal.FieldTH</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_Control-Lens-Internal-FieldTH.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Lens-Internal-FieldTH.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">lens-4.11.1: Lenses, Folds and Traversals</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(C) 2014-2015 Edward Kmett, (C) 2014 Eric Mertens</td></tr><tr><th>License</th><td>BSD-style (see the file LICENSE)</td></tr><tr><th>Maintainer</th><td>Edward Kmett <ekmett@gmail.com></td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>non-portable</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Control.Lens.Internal.FieldTH</p></div><div id="description"><p class="caption">Description</p><div class="doc empty"> </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">data</span> <a href="#t:LensRules">LensRules</a> = <a href="#v:LensRules">LensRules</a> {<ul class="subs"><li><a href="#v:_simpleLenses">_simpleLenses</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:_generateSigs">_generateSigs</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:_generateClasses">_generateClasses</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:_allowIsos">_allowIsos</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:_allowUpdates">_allowUpdates</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:_lazyPatterns">_lazyPatterns</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:_fieldToDef">_fieldToDef</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> [<a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a>] -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> [<a href="Control-Lens-Internal-FieldTH.html#t:DefName">DefName</a>]</li><li><a href="#v:_classyLenses">_classyLenses</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a>, <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a>)</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:DefName">DefName</a><ul class="subs"><li>= <a href="#v:TopName">TopName</a> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a></li><li>| <a href="#v:MethodName">MethodName</a> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a></li></ul></li><li class="src short"><a href="#v:makeFieldOptics">makeFieldOptics</a> :: <a href="Control-Lens-Internal-FieldTH.html#t:LensRules">LensRules</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:DecsQ">DecsQ</a></li><li class="src short"><a href="#v:makeFieldOpticsForDec">makeFieldOpticsForDec</a> :: <a href="Control-Lens-Internal-FieldTH.html#t:LensRules">LensRules</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Dec">Dec</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:DecsQ">DecsQ</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:LensRules" class="def">LensRules</a> <a href="src/Control-Lens-Internal-FieldTH.html#LensRules" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:LensRules" class="def">LensRules</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:_simpleLenses" class="def">_simpleLenses</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:_generateSigs" class="def">_generateSigs</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:_generateClasses" class="def">_generateClasses</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:_allowIsos" class="def">_allowIsos</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:_allowUpdates" class="def">_allowUpdates</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Allow Lens<em>Traversal (otherwise Getter</em>Fold)</p></dd><dt class="src"><a name="v:_lazyPatterns" class="def">_lazyPatterns</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:_fieldToDef" class="def">_fieldToDef</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> [<a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a>] -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> [<a href="Control-Lens-Internal-FieldTH.html#t:DefName">DefName</a>]</dt><dd class="doc"><p>Type Name -> Field Names -> Target Field Name -> Definition Names</p></dd><dt class="src"><a name="v:_classyLenses" class="def">_classyLenses</a> :: <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a>, <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a>)</dt><dd class="doc empty"> </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:DefName" class="def">DefName</a> <a href="src/Control-Lens-Internal-FieldTH.html#DefName" class="link">Source</a></p><div class="doc"><p>Name to give to generated field optics.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TopName" class="def">TopName</a> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a></td><td class="doc"><p>Simple top-level definiton name</p></td></tr><tr><td class="src"><a name="v:MethodName" class="def">MethodName</a> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a></td><td class="doc"><p>makeFields-style class name and method name</p></td></tr></table></div><div class="subs instances"><p id="control.i:DefName" class="caption collapser" onclick="toggleSection('i:DefName')">Instances</p><div id="section.i:DefName" class="show"><table><tr><td class="src"><a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Control-Lens-Internal-FieldTH.html#t:DefName">DefName</a> <a href="src/Control-Lens-Internal-FieldTH.html#line-563" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Control-Lens-Internal-FieldTH.html#t:DefName">DefName</a> <a href="src/Control-Lens-Internal-FieldTH.html#line-563" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> <a href="Control-Lens-Internal-FieldTH.html#t:DefName">DefName</a> <a href="src/Control-Lens-Internal-FieldTH.html#line-563" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:makeFieldOptics" class="def">makeFieldOptics</a> :: <a href="Control-Lens-Internal-FieldTH.html#t:LensRules">LensRules</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Name">Name</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:DecsQ">DecsQ</a> <a href="src/Control-Lens-Internal-FieldTH.html#makeFieldOptics" class="link">Source</a></p><div class="doc"><p>Compute the field optics for the type identified by the given type name.
Lenses will be computed when possible, Traversals otherwise.</p></div></div><div class="top"><p class="src"><a name="v:makeFieldOpticsForDec" class="def">makeFieldOpticsForDec</a> :: <a href="Control-Lens-Internal-FieldTH.html#t:LensRules">LensRules</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Syntax.html#t:Dec">Dec</a> -> <a href="file:///usr/local/share/doc/ghc/html/libraries/template-haskell-2.10.0.0/Language-Haskell-TH-Lib.html#t:DecsQ">DecsQ</a> <a href="src/Control-Lens-Internal-FieldTH.html#makeFieldOpticsForDec" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.0</p></div></body></html>