Control.Lens.At

At

class At m where

At provides a Lens that can be used to read, write or delete the value associated with a key in a Map-like container on an ad hoc basis.

An instance of At should satisfy:

 ix k ≡ at k <. traverse

Methods

at :: Index m -> IndexedLens' (Index m) m (Maybe (IxValue m))

>>> Map.fromList [(1,"world")] ^.at 1
Just "world"

>>> at 1 ?~ "hello" $ Map.empty
fromList [(1,"hello")]

Note: Map-like containers form a reasonable instance, but not Array-like ones, where you cannot satisfy the Lens laws.

Instances

At (IntMap a)

Ord k => At (Map k a)

(Eq k, Hashable k) => At (HashMap k a)

Ixed

type family IxValue m :: *

This provides a common notion of a value at an index that is shared by both Ixed and At.

class (Functor f, Contains (Accessor (IxValue m)) m) => Ixed f m where

This simple IndexedTraversal lets you traverse the value at a given key in a Map or element at an ordinal position in a list or Seq.

Methods

ix :: Index m -> IndexedLensLike' (Index m) f m (IxValue m)

This simple IndexedTraversal lets you traverse the value at a given key in a Map or element at an ordinal position in a list or Seq.

NB: Setting the value of this Traversal will only set the value in the Lens if it is already present.

If you want to be able to insert missing values, you want at.

>>> Seq.fromList [a,b,c,d] & ix 2 %~ f
fromList [a,b,f c,d]

>>> Seq.fromList [a,b,c,d] & ix 2 .~ e
fromList [a,b,e,d]

>>> Seq.fromList [a,b,c,d] ^? ix 2
Just c

>>> Seq.fromList [] ^? ix 2
Nothing

Instances

(Functor f, Contains (Accessor (IxValue ByteString)) ByteString, Applicative f) => Ixed f ByteString

(Functor f, Contains (Accessor (IxValue ByteString)) ByteString, Applicative f) => Ixed f ByteString

(Functor f, Contains (Accessor (IxValue Text)) Text, Applicative f) => Ixed f Text

(Functor f, Contains (Accessor (IxValue Text)) Text, Applicative f) => Ixed f Text

(Functor f, Contains (Accessor (IxValue (Complex a))) (Complex a), Applicative f) => Ixed f (Complex a)

(Functor f, Contains (Accessor (IxValue (Vector a))) (Vector a), Applicative f, Unbox a) => Ixed f (Vector a)

(Functor f, Contains (Accessor (IxValue (Vector a))) (Vector a), Applicative f, Storable a) => Ixed f (Vector a)

(Functor f, Contains (Accessor (IxValue (Vector a))) (Vector a), Applicative f, Prim a) => Ixed f (Vector a)

(Functor f, Contains (Accessor (IxValue (Vector a))) (Vector a), Applicative f) => Ixed f (Vector a)

(Functor f, Contains (Accessor (IxValue (IntMap a))) (IntMap a), Applicative f) => Ixed f (IntMap a)

(Functor f, Contains (Accessor (IxValue (Seq a))) (Seq a), Applicative f) => Ixed f (Seq a)

(Functor f, Contains (Accessor (IxValue (Tree a))) (Tree a), Applicative f) => Ixed f (Tree a)

(Contains (Accessor (IxValue (Identity a))) (Identity a), Functor f) => Ixed f (Identity a)

(Functor f, Contains (Accessor (IxValue [a])) [a], Applicative f) => Ixed f [a]

(Functor f, Contains (Accessor (IxValue (a, b))) (a, b), Applicative f, ~ * a b) => Ixed f (a, b)

(Contains (Accessor (IxValue (k -> a))) (k -> a), Functor f, Eq k) => Ixed f (k -> a)

(Functor f, Contains (Accessor (IxValue (UArray i e))) (UArray i e), Applicative f, IArray UArray e, Ix i) => Ixed f (UArray i e)

 arr ! i ≡ arr ^. ix i
 arr // [(i,e)] ≡ ix i .~ e $ arr

(Functor f, Contains (Accessor (IxValue (Array i e))) (Array i e), Applicative f, Ix i) => Ixed f (Array i e)

 arr ! i ≡ arr ^. ix i
 arr // [(i,e)] ≡ ix i .~ e $ arr

(Functor f, Contains (Accessor (IxValue (HashMap k a))) (HashMap k a), Applicative f, Eq k, Hashable k) => Ixed f (HashMap k a)

(Functor f, Contains (Accessor (IxValue (Map k a))) (Map k a), Applicative f, Ord k) => Ixed f (Map k a)

(Functor f, Contains (Accessor (IxValue (a, b, c))) (a, b, c), Applicative f, ~ * a b, ~ * b c) => Ixed f (a, b, c)

(Functor f, Contains (Accessor (IxValue (a, b, c, d))) (a, b, c, d), Applicative f, ~ * a b, ~ * b c, ~ * c d) => Ixed f (a, b, c, d)

(Functor f, Contains (Accessor (IxValue (a, b, c, d, e))) (a, b, c, d, e), Applicative f, ~ * a b, ~ * b c, ~ * c d, ~ * d e) => Ixed f (a, b, c, d, e)

(Functor f, Contains (Accessor (IxValue (a, b, c, d, e, f'))) (a, b, c, d, e, f'), Applicative f, ~ * a b, ~ * b c, ~ * c d, ~ * d e, ~ * e f') => Ixed f (a, b, c, d, e, f')

(Functor f, Contains (Accessor (IxValue (a, b, c, d, e, f', g))) (a, b, c, d, e, f', g), Applicative f, ~ * a b, ~ * b c, ~ * c d, ~ * d e, ~ * e f', ~ * f' g) => Ixed f (a, b, c, d, e, f', g)

(Functor f, Contains (Accessor (IxValue (a, b, c, d, e, f', g, h))) (a, b, c, d, e, f', g, h), Applicative f, ~ * a b, ~ * b c, ~ * c d, ~ * d e, ~ * e f', ~ * f' g, ~ * g h) => Ixed f (a, b, c, d, e, f', g, h)

(Functor f, Contains (Accessor (IxValue (a, b, c, d, e, f', g, h, i))) (a, b, c, d, e, f', g, h, i), Applicative f, ~ * a b, ~ * b c, ~ * c d, ~ * d e, ~ * e f', ~ * f' g, ~ * g h, ~ * h i) => Ixed f (a, b, c, d, e, f', g, h, i)

ixAt :: (Applicative f, At m) => Index m -> IndexedLensLike' (Index m) f m (IxValue m)

A definition of ix for types with an At instance. This is the default if you don't specify a definition for ix.

ixEach :: (Applicative f, Eq (Index m), Each f m m (IxValue m) (IxValue m)) => Index m -> IndexedLensLike' (Index m) f m (IxValue m)

A definition of ix for types with an Each instance.

Contains

class Functor f => Contains f m where

This class provides a simple IndexedFold (or IndexedTraversal) that lets you view (and modify) information about whether or not a container contains a given Index.

Methods

contains :: Index m -> IndexedLensLike' (Index m) f m Bool

>>> IntSet.fromList [1,2,3,4] ^. contains 3
True

>>> IntSet.fromList [1,2,3,4] ^. contains 5
False

>>> IntSet.fromList [1,2,3,4] & contains 3 .~ False
fromList [1,2,4]

Instances

(Functor f, Gettable f) => Contains f ByteString

(Functor f, Gettable f) => Contains f ByteString

(Functor f, Gettable f) => Contains f Text

(Functor f, Gettable f) => Contains f Text

Functor f => Contains f IntSet

(Functor f, Gettable f, Unbox a) => Contains f (Vector a)

(Functor f, Gettable f, Storable a) => Contains f (Vector a)

(Functor f, Gettable f, Prim a) => Contains f (Vector a)

(Functor f, Gettable f) => Contains f (Vector a)

(Functor k, Gettable k) => Contains k (IntMap a)

(Functor k, Gettable k) => Contains k (Identity a)

(Functor f, Gettable f) => Contains f (Tree a)

(Functor f, Gettable f) => Contains f (Complex a)

(Functor f, Gettable f) => Contains f (Seq a)

(Functor f, Gettable f) => Contains f [a]

(Functor f, Eq a, Hashable a) => Contains f (HashSet a)

(Functor f, Ord a) => Contains f (Set a)

(Functor f, Gettable f, IArray UArray e, Ix i) => Contains f (UArray i e)

(Functor f, Gettable f, Ix i) => Contains f (Array i e)

(Functor f, Gettable f, Eq k, Hashable k) => Contains f (HashMap k a)

(Functor f, Gettable f, Ord k) => Contains f (Map k a)

(Functor k, Gettable k) => Contains k (a, b)

(Functor f, Gettable f) => Contains f (e -> a)

(Functor k, Gettable k) => Contains k (a, b, c)

(Functor k, Gettable k) => Contains k (a, b, c, d)

(Functor k, Gettable k) => Contains k (a, b, c, d, e)

(Functor k, Gettable k) => Contains k (a, b, c, d, e, f)

(Functor k, Gettable k) => Contains k (a, b, c, d, e, f, g)

(Functor k, Gettable k) => Contains k (a, b, c, d, e, f, g, h)

(Functor k, Gettable k) => Contains k (a, b, c, d, e, f, g, h, i)

containsIx :: (Gettable f, Ixed (Accessor Any) m) => Index m -> IndexedLensLike' (Index m) f m Bool

A definition of contains for types with an Ix instance.

containsAt :: (Gettable f, At m) => Index m -> IndexedLensLike' (Index m) f m Bool

A definition of ix for types with an At instance. This is the default if you don't specify a definition for contains and you are on GHC >= 7.0.2

containsLength :: forall i s. (Ord i, Num i) => (s -> i) -> i -> IndexedGetter i s Bool

Construct a contains check based on some notion of length for the container.

containsN :: Int -> Int -> IndexedGetter Int s Bool

Construct a contains check for a fixed number of elements.

containsTest :: forall i s. (i -> s -> Bool) -> i -> IndexedGetter i s Bool

Construct a contains check that uses an arbitrary test.

containsLookup :: forall i s a. (i -> s -> Maybe a) -> i -> IndexedGetter i s Bool

Construct a contains check that uses an arbitrary lookup function.

Deprecated

_at :: Ixed f m => Index m -> IndexedLensLike' (Index m) f m (IxValue m)

Deprecated: use 'ix'. This function will be removed in version 3.9

Deprecated aliases for ix.

resultAt :: Ixed f m => Index m -> IndexedLensLike' (Index m) f m (IxValue m)

Deprecated: use 'ix'. This function will be removed in version 3.9

Deprecated aliases for ix.