| Copyright | (c) 2012--2021 The University of Kansas |
|---|---|
| License | BSD3 |
| Maintainer | Neil Sculthorpe <neil.sculthorpe@ntu.ac.uk> |
| Stability | beta |
| Portability | ghc |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Language.KURE.Lens
Contents
Description
This module defines the KURE Lens type, along with some useful operations.
Synopsis
- data Lens c m a b
- lens :: Transform c m a ((c, b), b -> m a) -> Lens c m a b
- lensT :: Lens c m a b -> Transform c m a ((c, b), b -> m a)
- focusR :: Monad m => Lens c m a b -> Rewrite c m b -> Rewrite c m a
- focusT :: Monad m => Lens c m a b -> Transform c m b d -> Transform c m a d
- pureL :: Monad m => (a -> b) -> (b -> a) -> Lens c m a b
- failL :: MonadFail m => String -> Lens c m a b
- catchL :: MonadCatch m => Lens c m a b -> (String -> Lens c m a b) -> Lens c m a b
- testLensT :: MonadCatch m => Lens c m a b -> Transform c m a Bool
- bidirectionalL :: Monad m => BiTransform c m a b -> Lens c m a b
- injectL :: (MonadFail m, Injection a g) => Lens c m a g
- projectL :: (MonadFail m, Injection a g) => Lens c m g a
Lenses
A Lens is a way to focus on a sub-structure of type b from a structure of type a.
lens :: Transform c m a ((c, b), b -> m a) -> Lens c m a b Source #
The primitive way of building a Lens.
If the unfocussing function is applied to the value focussed on then it should succeed,
and produce the same value as the original argument (of type a).
focusR :: Monad m => Lens c m a b -> Rewrite c m b -> Rewrite c m a Source #
Apply a rewrite at a point specified by a Lens.
focusT :: Monad m => Lens c m a b -> Transform c m b d -> Transform c m a d Source #
Apply a transformation at a point specified by a Lens.
pureL :: Monad m => (a -> b) -> (b -> a) -> Lens c m a b Source #
Construct a Lens from two pure functions.
catchL :: MonadCatch m => Lens c m a b -> (String -> Lens c m a b) -> Lens c m a b Source #
A Lens is deemed to have failed (and thus can be caught) if either it fails on the way down, or,
crucially, if it would fail on the way up for an unmodified value. However, actual failure on the way up is not caught
(as by then it is too late to use an alternative Lens). This means that, in theory, a use of catchL could cause a succeeding Lens application to fail.
But provided lens is used correctly, this should never happen.
testLensT :: MonadCatch m => Lens c m a b -> Transform c m a Bool Source #
Check if the focusing succeeds, and additionally whether unfocussing from an unchanged value would succeed.
bidirectionalL :: Monad m => BiTransform c m a b -> Lens c m a b Source #
Construct a Lens from a BiTransform.