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.

Constructors

Patch
Fields patchOperations :: [Operation]

Instances

Eq Patch Source
Show Patch Source
ToJSON Patch Source
FromJSON Patch Source
Monoid Patch Source

data Pointer Source

Pointer to a location in a JSON document.

Defined in RFC 6901 http://tools.ietf.org/html/rfc6901

Instances

Eq Pointer Source
Show Pointer Source
ToJSON Pointer Source
FromJSON Pointer Source
Monoid Pointer Source

data Key Source

Traverse a single layer of a JSON document.

Constructors

OKey Text	Traverse a `Value` with an `Object` constructor.
AKey Int	Traverse a `Value` with an `Array` constructor.

Instances

Eq Key Source
Ord Key Source
Show Key Source
ToJSON Key Source
FromJSON Key Source

data Operation Source

An Operation describes an atomic change to a JSON document.

See RFC 6902 Section 4 http://tools.ietf.org/html/rfc6902#section-4.

Constructors

Add	http://tools.ietf.org/html/rfc6902#section-4.1
Fields changePointer :: Pointer changeValue :: Value
Rem	http://tools.ietf.org/html/rfc6902#section-4.2
Fields changePointer :: Pointer changeValue :: Value
Rep	http://tools.ietf.org/html/rfc6902#section-4.3
Fields changePointer :: Pointer changeValue :: Value
Mov	http://tools.ietf.org/html/rfc6902#section-4.4
Fields changePointer :: Pointer fromPointer :: Pointer
Cpy	http://tools.ietf.org/html/rfc6902#section-4.5
Fields changePointer :: Pointer fromPointer :: Pointer
Tst	http://tools.ietf.org/html/rfc6902#section-4.6
Fields changePointer :: Pointer changeValue :: Value

Instances

Eq Operation Source
Show Operation Source
ToJSON Operation Source
FromJSON Operation Source

Functions

diff :: Value -> Value -> Patch Source

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

patch :: Patch -> Value -> Result Value Source

Apply a patch to a JSON document.

patch' :: Patch -> Value -> Value Source

Apply a patch to a JSON document.

If the patch cannot be cleanly applied an error is thrown.

applyOperation :: Operation -> Value -> Result Value Source

Apply an Operation to a Value.

formatPatch :: Patch -> Text Source

Format a Patch for reading by humans.

For storing or exchanging Patches between systems using the JSON encoding implemented by the FromJSON and ToJSON instances.