The lens package

[Tags: bsd3, library]

This package comes "Batteries Included" with many useful lenses for the types commonly used from the Haskell Platform, and with tools for automatically generating lenses and isomorphisms for user-supplied data types.

The combinators in Control.Lens provide a highly generic toolbox for composing families of getters, folds, isomorphisms, traversals, setters and lenses and their indexed variants.

An overview, with a large number of examples can be found in the README.

An introductory video on the style of code used in this library by Simon Peyton Jones is available from Skills Matter.

A video on how to use lenses and how they are constructed is available on youtube.

Slides for that second talk can be obtained from comonad.com.

More information on the care and feeding of lenses, including a brief tutorial and motivation for their types can be found on the lens wiki.

A small game of pong and other more complex examples that manage their state using lenses can be found in the example folder.

Lenses, Folds and Traversals

With some signatures simplified, the core of the hierarchy of lens-like constructions looks like:

(Local Copy)

You can compose any two elements of the hierarchy above using (.) from the Prelude, and you can use any element of the hierarchy as any type it linked to above it.

The result is their lowest upper bound in the hierarchy (or an error if that bound doesn't exist).

For instance:

Minimizing Dependencies

If you want to provide lenses and traversals for your own types in your own libraries, then you can do so without incurring a dependency on this (or any other) lens package at all.

e.g. for a data type:

 data Foo a = Foo Int Int a

You can define lenses such as

 -- bar :: Lens' (Foo a) Int
 bar :: Functor f => (Int -> f Int) -> Foo a -> f (Foo a)
 bar f (Foo a b c) = fmap (\a' -> Foo a' b c) (f a)
 -- quux :: Lens (Foo a) (Foo b) a b
 quux :: Functor f => (a -> f b) -> Foo a -> f (Foo b)
 quux f (Foo a b c) = fmap (Foo a b) (f c)

without the need to use any type that isn't already defined in the Prelude.

And you can define a traversal of multiple fields with Control.Applicative.Applicative:

 -- traverseBarAndBaz :: Traversal' (Foo a) Int
 traverseBarAndBaz :: Applicative f => (Int -> f Int) -> Foo a -> f (Foo a)
 traverseBarAndBaz f (Foo a b c) = Foo <$> f a <*> f b <*> pure c

What is provided in this library is a number of stock lenses and traversals for common haskell types, a wide array of combinators for working them, and more exotic functionality, (e.g. getters, setters, indexed folds, isomorphisms).


Properties

Versions0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.0.1, 1.0.2, 1.0.3, 1.1, 1.1.1, 1.2, 1.3, 1.3.1, 1.4, 1.4.1, 1.5, 1.6, 1.7, 1.7.1, 1.8, 1.9, 1.9.1, 2.0, 2.1, 2.2, 2.3, 2.4, 2.4.0.2, 2.5, 2.6, 2.6.1, 2.7, 2.7.0.1, 2.8, 2.9, 3.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.0.5, 3.0.6, 3.1, 3.2, 3.3, 3.4, 3.5, 3.5.1, 3.6, 3.6.0.1, 3.6.0.2, 3.6.0.3, 3.6.0.4, 3.7, 3.7.0.1, 3.7.0.2, 3.7.1, 3.7.1.1, 3.7.1.2, 3.7.2, 3.7.3, 3.7.4, 3.7.5, 3.7.6, 3.8, 3.8.0.1, 3.8.0.2, 3.8.1, 3.8.2, 3.8.3, 3.8.4, 3.8.5, 3.8.6, 3.8.7, 3.8.7.1, 3.8.7.2, 3.8.7.3, 3.9, 3.9.0.1, 3.9.0.2, 3.9.0.3, 3.9.1, 3.9.2, 3.10, 3.10.0.1, 3.10.1, 3.10.2, 3.10.3, 4.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.0.5, 4.0.6, 4.0.7, 4.1, 4.1.1, 4.1.2, 4.1.2.1, 4.2, 4.3, 4.3.1, 4.3.2, 4.3.3, 4.4, 4.4.0.1, 4.4.0.2
Dependenciesaeson (==0.7.*), array (>=0.3.0.2 && <0.6), base (>=4.3 && <5), bifunctors (==4.*), bytestring (>=0.9.1.10 && <0.11), comonad (==4.*), constraints (>=0.3.3 && <1), containers (>=0.4.0 && <0.6), contravariant (>=0.3 && <1), distributive (>=0.3 && <1), exceptions (>=0.1.1 && <1), filepath (>=1.2.0.0 && <1.4), ghc-prim, hashable (>=1.1.2.3 && <1.3), mtl (>=2.0.1 && <2.2), parallel (>=3.1.0.1 && <3.3), primitive (>=0.4.0.1 && <0.6), profunctors (==4.*), reflection (>=1.1.6 && <2), scientific (==0.2.*), semigroupoids (>=4 && <4.1), semigroups (>=0.8.4 && <1), split (==0.2.*), tagged (>=0.4.4 && <1), template-haskell (>=2.4 && <2.10), text (>=0.11 && <1.2), transformers (>=0.2 && <0.4), transformers-compat (>=0.1 && <1), unordered-containers (==0.2.*), utf8-string (>=0.3.7 && <0.4), vector (>=0.9 && <0.11), void (>=0.5 && <1), zlib (>=0.5.4 && <0.6)
LicenseBSD3
CopyrightCopyright (C) 2012-2014 Edward A. Kmett
AuthorEdward A. Kmett
MaintainerEdward A. Kmett <ekmett@gmail.com>
Stabilityprovisional
CategoryData, Lenses, Generics
Home pagehttp://github.com/ekmett/lens/
Bug trackerhttp://github.com/ekmett/lens/issues
Source repositoryhead: git clone git://github.com/ekmett/lens.git
Upload dateSat Aug 2 11:16:10 UTC 2014
Uploaded byEdwardKmett
DistributionsDebian:4.1.2.1, FreeBSD:3.9.0.2, NixOS:4.4.0.2
Downloads81456 total (7820 in last 30 days)

Modules

[Index]

Flags

NameDescriptionDefault
benchmark-uniplateDisabled
inliningEnabled
old-inline-pragmasDisabled
dump-splicesDisabled
test-hlintEnabled
test-doctestsEnabled
test-hunitEnabled
test-propertiesEnabled
safeDisabled
trustworthyEnabled
lib-werrorDisabled
jDisabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees