lens: Lenses, Folds and Traversals

[ bsd2, data, generics, lenses, library ] [ Propose Tags ]

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.

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

https://github.com/ekmett/lens/wiki

A small game that manages its state using lenses can be found in the example folder.

https://github.com/ekmett/lens/blob/master/examples/Pong.hs

Lenses, Folds and Traversals

The core of this hierarchy looks like:

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 links to above it.

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

For instance:

  • You can use any Traversal as a Fold or as a Setter.

  • The composition of a Traversal and a Getter yields a Fold.

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 :: Simple 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)
-- baz :: 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 :: Simple 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).


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.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, 4.5, 4.6, 4.6.0.1, 4.7, 4.7.0.1, 4.8, 4.9, 4.9.1, 4.10, 4.11, 4.11.1, 4.12, 4.12.1, 4.12.2, 4.12.3, 4.13, 4.13.1, 4.13.2, 4.13.2.1, 4.14, 4.15, 4.15.1, 4.15.2, 4.15.3, 4.15.4, 4.16, 4.16.1, 4.17, 4.17.1, 4.18, 4.18.1, 4.19, 4.19.1, 4.19.2, 5, 5.0.1, 5.1, 5.1.1, 5.2, 5.2.1, 5.2.2, 5.2.3
Dependencies array (>=0.3.0.2 && <0.5), base (>=4.3 && <5), bytestring (>=0.9.1.10 && <0.10), containers (>=0.4.2 && <0.6), ghc-prim, mtl (>=2.0.1 && <2.2), parallel (>=3.1.0.1 && <3.3), template-haskell (>=2.4 && <2.8), text (>=0.11.1.5 && <0.12), transformers (>=0.3 && <0.4) [details]
License BSD-3-Clause
Copyright Copyright (C) 2012 Edward A. Kmett
Author Edward A. Kmett
Maintainer Edward A. Kmett <ekmett@gmail.com>
Category Data, Lenses
Home page http://github.com/ekmett/lens/
Bug tracker http://github.com/ekmett/lens/issues
Source repo head: git clone git://github.com/ekmett/lens.git
Uploaded by EdwardKmett at 2012-08-09T20:41:31Z
Distributions Arch:5.2.3, Debian:4.18.1, Fedora:5.2.2, FreeBSD:4.12.3, LTSHaskell:5.2.3, NixOS:5.2.3, Stackage:5.2.3, openSUSE:5.2.3
Reverse Dependencies 1409 direct, 6319 indirect [details]
Downloads 415179 total (686 in the last 30 days)
Rating 3.0 (votes: 50) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for lens-1.8

[back to package description]

lens

Build Status

This package provides families of lenses, isomorphisms, folds, traversals, getters and setters.

These lenses are compatible with those from lens-family, lens-family-core and lens-family-th, but they provide a great deal of additional flexibility in their composition.

An overview of the derivation of setters, folds, traversals, getters and lenses can be found on the lens wiki under Tutorial.

Lens Hierarchy

Example

ghci> :m + Control.Lens Data.Text.Lens
ghci> anyOf (traverse.text) (=='y') ["hello"^.packed, "goodbye"^.packed]
True

Contact Information

Contributions and bug reports are welcome!

Please feel free to contact me through github or on the #haskell IRC channel on irc.freenode.net.

-Edward Kmett