Data.Aeson.Diff

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.

Patches

newtype Patch

Describes the changes between two JSON documents.

Constructors

Patch

Fields

• patchOperations :: [Operation]

Instances

Eq Patch

Methods

(==) :: Patch -> Patch -> Bool

(/=) :: Patch -> Patch -> Bool

Show Patch

Methods

showsPrec :: Int -> Patch -> ShowS

show :: Patch -> String

showList :: [Patch] -> ShowS

Monoid Patch

Methods

mempty :: Patch

mappend :: Patch -> Patch -> Patch

mconcat :: [Patch] -> Patch

ToJSON Patch

Methods

toJSON :: Patch -> Value

toEncoding :: Patch -> Encoding

toJSONList :: [Patch] -> Value

toEncodingList :: [Patch] -> Encoding

FromJSON Patch

Methods

parseJSON :: Value -> Parser Patch

parseJSONList :: Value -> Parser [Patch]

data Pointer

Pointer to a location in a JSON document.

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

Instances

Eq Pointer

Methods

(==) :: Pointer -> Pointer -> Bool

(/=) :: Pointer -> Pointer -> Bool

Ord Pointer

Methods

compare :: Pointer -> Pointer -> Ordering

(<) :: Pointer -> Pointer -> Bool

(<=) :: Pointer -> Pointer -> Bool

(>) :: Pointer -> Pointer -> Bool

(>=) :: Pointer -> Pointer -> Bool

max :: Pointer -> Pointer -> Pointer

min :: Pointer -> Pointer -> Pointer

Show Pointer

Methods

showsPrec :: Int -> Pointer -> ShowS

show :: Pointer -> String

showList :: [Pointer] -> ShowS

Monoid Pointer

Methods

mempty :: Pointer

mappend :: Pointer -> Pointer -> Pointer

mconcat :: [Pointer] -> Pointer

ToJSON Pointer

Methods

toJSON :: Pointer -> Value

toEncoding :: Pointer -> Encoding

toJSONList :: [Pointer] -> Value

toEncodingList :: [Pointer] -> Encoding

FromJSON Pointer

Methods

parseJSON :: Value -> Parser Pointer

parseJSONList :: Value -> Parser [Pointer]

data Key

Path components to 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

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

ToJSON Key

Methods

toJSON :: Key -> Value

toEncoding :: Key -> Encoding

toJSONList :: [Key] -> Value

toEncodingList :: [Key] -> Encoding

FromJSON Key

Methods

parseJSON :: Value -> Parser Key

parseJSONList :: Value -> Parser [Key]

data Operation

An Operation describes the operations which can appear as part of a JSON Patch.

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

Cpy

http://tools.ietf.org/html/rfc6902#section-4.5

Fields

• changePointer :: Pointer
• fromPointer :: Pointer

Mov

http://tools.ietf.org/html/rfc6902#section-4.4

Fields

• changePointer :: Pointer
• fromPointer :: Pointer

Rem

http://tools.ietf.org/html/rfc6902#section-4.2

Fields

• changePointer :: Pointer

Rep

http://tools.ietf.org/html/rfc6902#section-4.3

Fields

• changePointer :: Pointer
• changeValue :: Value

Tst

http://tools.ietf.org/html/rfc6902#section-4.6

Fields

• changePointer :: Pointer
• changeValue :: Value

Instances

Eq Operation

Methods

(==) :: Operation -> Operation -> Bool

(/=) :: Operation -> Operation -> Bool

Show Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

ToJSON Operation

Methods

toJSON :: Operation -> Value

toEncoding :: Operation -> Encoding

toJSONList :: [Operation] -> Value

toEncodingList :: [Operation] -> Encoding

FromJSON Operation

Methods

parseJSON :: Value -> Parser Operation

parseJSONList :: Value -> Parser [Operation]

newtype Config

Configuration for the diff algorithm.

Constructors

Config

Fields

• configTstBeforeRem :: Bool

Functions

diff :: Value -> Value -> Patch

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

Uses the defaultConfig.

diff' :: Config -> Value -> Value -> Patch

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

patch :: Patch -> Value -> Result Value

Apply a patch to a JSON document.

applyOperation :: Operation -> Value -> Result Value

Apply an Operation to a Value.