Profunctor optics/lenses for Idris2 | GitHub Mirror: https://github.com/kiana-S/idris2-lens
Find a file
2024-06-29 01:55:20 -04:00
src Fix typo 2024-06-29 01:55:20 -04:00
.gitignore Initial commit 2023-03-31 13:22:03 -04:00
lens.ipkg Update version to 0.3.0 2023-10-19 16:23:53 -04:00
LICENSE Initial commit 2023-03-31 13:22:03 -04:00
README.md Update README 2023-10-19 16:23:05 -04:00

Profunctor Optics in Idris2

This package provides utilities for working with lenses, prisms, traversals, and other optics in Idris. This library uses profunctor optics.

Comparison to Monocle

Monocle is another Idris 2 library for lenses. That library represents lenses using a datatype, which is often less efficient at run-time, but results in better error messages and is generally simpler to understand.

Comparisons to Non-Idris Libraries

This library is inspired by the Haskell libraries lens, optics and fresnel, along with the Purescript library purescript-profunctor-lenses. Different design decisions are taken from each library.

Like lens, this library comes "batteries-included" with many useful lenses for common types. It also includes the many lens operators. Like optics, fresnel and purescript-profunctor-lenses, but unlike lens, this library uses profunctor optics as opposed to van Laarhoven optics.

Like lens and fresnel, this library defines optics through type synonyms and uses the (.) operator to compose them. Like fresnel, and unlike lens, this library goes to some effort to ensure that type signatures and error messages are understandable to some degree.

This library's optics hierarchy is most similar to that of fresnel, though it also includes the Equality optic from lens. Unlike fresnel, this library also supports indexed optics.

Installation

This package depends on the profunctors package. It can be installed from pack or from its GitHub repository here.

To install using idris2 directly:

git clone https://github.com/kiana-S/idris2-lens
cd idris2-lens
idris2 --install lens.ipkg

Or you can install using pack:

pack install lens

Thanks

Special thanks to Stefan Höck for assistance with writing elaboration scripts.