Data.Aeson.Diff.Generic.PathOptics

type synonyms

type PathLens s a = Lens' (Path, s) (Path, a)

type PathTraversal s a = Traversal' (Path, s) (Path, a)

operations over path optics

overPath :: ToJSON a => PathTraversal s a -> (a -> a) -> s -> (Patch, s)

Modify the value(s) at the traversal, and return a patch which represents those (replace) operations.

replacePath :: ToJSON a => PathTraversal s a -> a -> s -> (Patch, s)

Replace the value at the traversal, and return a patch with the replace operations.

getPath :: PathTraversal s a -> s -> [(Pointer, a)]

Return the values and pointers pointed to by the traversal (if any)

appendPath :: (ToJSON (IxValue a), Appendable a) => IxValue a -> PathTraversal s a -> s -> (Patch, s)

Append a value to the structure pointed by the lens. Return a patch which the append operations)

insertPath :: (ToJSON (IxValue a), Insertable a) => Index a -> IxValue a -> PathTraversal s a -> s -> (Patch, s)

Insert a value at the given key, and return a patch with the insert operations

deletePath :: (ToJSON (IxValue a), Insertable a) => Index a -> PathTraversal s a -> s -> (Patch, s)

Delete a value at the given key if present, and return a patch with the delete operations.

testPath :: ToJSON a => PathTraversal s a -> s -> (Patch, s)

Create a patch that tests if the value at the pointer equals the current value. Returns the data unmodified.

class KeyIndexed s where

Minimal complete definition

toKey

Methods

toKey :: Index s -> s -> Key

class KeyIndexed a => Insertable a where

Minimal complete definition

insertKey, deleteKey

Methods

insertKey :: Index a -> IxValue a -> a -> a

deleteKey :: Index a -> a -> Maybe (IxValue a, a)

class KeyIndexed a => Appendable a where

Minimal complete definition

append

Methods

append :: IxValue a -> a -> a

creating and extracting path optics

withPath

Arguments

:: Functor f

=> Path

the path into the structure

-> ((a -> Compose f ((,) Path) a) -> s -> Compose f ((,) Path) s)

the input optic

-> ((Path, a) -> f (Path, a)) -> (Path, s) -> f (Path, s)

the output optic with path information

Annotate an optic with a path. The output optic will be the same optic, with a path annotation. For example:

withPath :: Path -> Lens' s a -> Lens' (Path, s) (Path, a)
withPath :: Path -> Traversal' s a -> Traversal' (Path, s) (Path, a)

withoutPath

Arguments

:: Functor f

=> (((Path, a) -> f (Path, a)) -> (Path, s) -> f (Path, s))

input optic

-> (a -> f a) -> s -> f s

output optic without path information

remove the path from an optic annotated with path information.

withoutPath . withPath ≡ id

The output optic will be the same optic, without the path annotation. For example:

withoutPath ::  Lens' (Path, s) (Path, a) -> Lens' s a
withoutPath :: Traversal' (Path, s) (Path, a) -> Traversal' s a

pathOptics

ixP :: (KeyIndexed s, Ixed s) => Index s -> Traversal' (Path, s) (Path, IxValue s)

ix from lens annotated with a path. Provides a simple Traversal lets you traverse the value at a given key in a Map or element at an ordinal position in a list or Seq. Includes the path to the element.

traverseP :: (a ~ Index (s a), TraversableWithIndex a s, KeyIndexed (s a)) => Traversal' (Path, s a) (Path, a)

_1P :: Field1 s s a a => PathLens s a

_2P :: Field2 s s a a => PathLens s a

_3P :: Field3 s s a a => PathLens s a

_4P :: Field4 s s a a => PathLens s a

_5P :: Field5 s s a a => PathLens s a

_6P :: Field6 s s a a => PathLens s a

_7P :: Field7 s s a a => PathLens s a

_8P :: Field8 s s a a => PathLens s a

_9P :: Field9 s s a a => PathLens s a

_10P :: Field10 s s a a => PathLens s a

_11P :: Field11 s s a a => PathLens s a

_12P :: Field12 s s a a => PathLens s a

_13P :: Field13 s s a a => PathLens s a

_14P :: Field14 s s a a => PathLens s a

_15P :: Field15 s s a a => PathLens s a

_16P :: Field16 s s a a => PathLens s a

_17P :: Field17 s s a a => PathLens s a

_18P :: Field18 s s a a => PathLens s a

_19P :: Field19 s s a a => PathLens s a

_LeftP :: Traversal' (Path, Either a b) (Path, a)

_RightP :: Traversal' (Path, Either a b) (Path, b)

_JustP :: Traversal' (Path, Maybe a) (Path, a)