Safe Haskell	None
Language	Haskell2010

Data.Aeson.Diff

Contents

Patches
Functions

Description

This module implements data types and operations to represent the differences between JSON documents (i.e. a patch), to compare JSON documents and extract such a patch, and to apply such a patch to a JSON document.

Synopsis

Patches

data Patch Source

Describes the changes between two JSON documents.

Instances

Eq Patch
Show Patch
ToJSON Patch
FromJSON Patch
Monoid Patch

patchOperations :: Patch -> [Operation] Source

type Path = [Key] Source

A path through a JSON document is a possibly empty sequence of Keys.

data Key Source

Traverse a single layer of a JSON document.

Constructors

OKey Text
AKey Int

Instances

Eq Key
Ord Key
Show Key
ToJSON Key
FromJSON Key

data Operation Source

Descripts an atomic change to a JSON document.

Constructors

Ins	Insert a value at a location.
Fields changePath :: Path changeValue :: Value
Del	Delete the value at a location.
Fields changePath :: Path changeValue :: Value

Instances

Eq Operation
Show Operation
ToJSON Operation
FromJSON Operation

Functions

diff :: Value -> Value -> Patch Source

Compare two JSON documents and generate a patch describing the differences.

patch :: Patch -> Value -> Value Source

Apply a patch to a JSON document.

applyOperation :: Operation -> Value -> Value Source

Apply an Operation to a Value.

formatPatch :: Patch -> Text Source

Format a Patch.