| Copyright | (C) 2014-2016 Edward Kmett (C) 2014 Eric Mertens |
|---|---|
| License | BSD-style (see the file LICENSE) |
| Maintainer | Edward Kmett <ekmett@gmail.com> |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | Safe |
| Language | Haskell2010 |
Control.Lens.Internal.FieldTH
Description
Synopsis
- data LensRules = LensRules {}
- type FieldNamer = Name -> [Name] -> Name -> [DefName]
- data DefName
- type ClassyNamer = Name -> Maybe (Name, Name)
- makeFieldOptics :: LensRules -> Name -> DecsQ
- makeFieldOpticsForDec :: LensRules -> Dec -> DecsQ
- makeFieldOpticsForDec' :: LensRules -> Dec -> HasFieldClasses [Dec]
- type HasFieldClasses = StateT (Set Name) Q
Documentation
Rules to construct lenses for data fields.
Constructors
| LensRules | |
Fields
| |
type FieldNamer #
Arguments
| = Name | Name of the data type that lenses are being generated for. |
| -> [Name] | Names of all fields (including the field being named) in the data type. |
| -> Name | Name of the field being named. |
| -> [DefName] | Name(s) of the lens functions. If empty, no lens is created for that field. |
The rule to create function names of lenses for data fields.
Although it's sometimes useful, you won't need the first two arguments most of the time.
Name to give to generated field optics.
Constructors
| TopName Name | Simple top-level definition name |
| MethodName Name Name | makeFields-style class name and method name |
type ClassyNamer #
Arguments
| = Name | Name of the data type that lenses are being generated for. |
| -> Maybe (Name, Name) | Names of the class and the main method it generates, respectively. |
The optional rule to create a class and method around a monomorphic data type. If this naming convention is provided, it generates a "classy" lens.
makeFieldOptics :: LensRules -> Name -> DecsQ #
Compute the field optics for the type identified by the given type name. Lenses will be computed when possible, Traversals otherwise.
makeFieldOpticsForDec :: LensRules -> Dec -> DecsQ #
makeFieldOpticsForDec' :: LensRules -> Dec -> HasFieldClasses [Dec] #