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

newtype Patch = Patch [Operation]
data Pointer
data Key
- = OKey Key
- | AKey Int
data Operation
- = Add {
  - changePointer :: Pointer
  - changeValue :: Value
  }
- | Cpy Pointer Pointer
- | Mov Pointer Pointer
- | Rem {
  - changePointer :: Pointer
  }
- | Rep {
  - changePointer :: Pointer
  - changeValue :: Value
  }
- | Tst {
  - changePointer :: Pointer
  - changeValue :: Value
  }
newtype Config = Config {
- configTstBeforeRem :: Bool
}
diff :: Value -> Value -> Patch
diff' :: Config -> Value -> Value -> Patch
patch :: Patch -> Value -> Result Value
applyOperation :: Operation -> Value -> Result Value

Patches

newtype Patch Source #

Describes the changes between two JSON documents.

Constructors

Patch [Operation]

Instances

Instances details

FromJSON Patch Source #

Instance details

Defined in Data.Aeson.Patch

Methods

parseJSON :: Value -> Parser Patch #

parseJSONList :: Value -> Parser [Patch] #

omittedField :: Maybe Patch #

ToJSON Patch Source #

Instance details

Defined in Data.Aeson.Patch

Methods

toJSON :: Patch -> Value #

toEncoding :: Patch -> Encoding #

toJSONList :: [Patch] -> Value #

toEncodingList :: [Patch] -> Encoding #

omitField :: Patch -> Bool #

Monoid Patch Source #

Instance details

Defined in Data.Aeson.Patch

Methods

mempty :: Patch #

mappend :: Patch -> Patch -> Patch #

mconcat :: [Patch] -> Patch #

Semigroup Patch Source #

Instance details

Defined in Data.Aeson.Patch

Methods

(<>) :: Patch -> Patch -> Patch #

sconcat :: NonEmpty Patch -> Patch #

stimes :: Integral b => b -> Patch -> Patch #

Generic Patch Source #

Instance details

Defined in Data.Aeson.Patch

Associated Types

type Rep Patch
Instance details Defined in Data.Aeson.Patch type Rep Patch = D1 ('MetaData "Patch" "Data.Aeson.Patch" "aeson-diff-1.1.0.13-4Ya90qLVgTyEUPMnzN8rMx" 'True) (C1 ('MetaCons "Patch" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Operation])))

Methods

from :: Patch -> Rep Patch x #

to :: Rep Patch x -> Patch #

Show Patch Source #

Instance details

Defined in Data.Aeson.Patch

Methods

showsPrec :: Int -> Patch -> ShowS #

show :: Patch -> String #

showList :: [Patch] -> ShowS #

Eq Patch Source #

Instance details

Defined in Data.Aeson.Patch

Methods

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

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

type Rep Patch Source #

Instance details

Defined in Data.Aeson.Patch

type Rep Patch = D1 ('MetaData "Patch" "Data.Aeson.Patch" "aeson-diff-1.1.0.13-4Ya90qLVgTyEUPMnzN8rMx" 'True) (C1 ('MetaCons "Patch" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Operation])))

data Pointer Source #

Pointer to a location in a JSON document.

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

Instances

Instances details

FromJSON Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

parseJSON :: Value -> Parser Pointer #

parseJSONList :: Value -> Parser [Pointer] #

omittedField :: Maybe Pointer #

ToJSON Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

toJSON :: Pointer -> Value #

toEncoding :: Pointer -> Encoding #

toJSONList :: [Pointer] -> Value #

toEncodingList :: [Pointer] -> Encoding #

omitField :: Pointer -> Bool #

Monoid Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

mempty :: Pointer #

mappend :: Pointer -> Pointer -> Pointer #

mconcat :: [Pointer] -> Pointer #

Semigroup Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

(<>) :: Pointer -> Pointer -> Pointer #

sconcat :: NonEmpty Pointer -> Pointer #

stimes :: Integral b => b -> Pointer -> Pointer #

Generic Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Associated Types

type Rep Pointer
Instance details Defined in Data.Aeson.Pointer type Rep Pointer = D1 ('MetaData "Pointer" "Data.Aeson.Pointer" "aeson-diff-1.1.0.13-4Ya90qLVgTyEUPMnzN8rMx" 'True) (C1 ('MetaCons "Pointer" 'PrefixI 'True) (S1 ('MetaSel ('Just "pointerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Path)))

Methods

from :: Pointer -> Rep Pointer x #

to :: Rep Pointer x -> Pointer #

Show Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

showsPrec :: Int -> Pointer -> ShowS #

show :: Pointer -> String #

showList :: [Pointer] -> ShowS #

Eq Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

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

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

Ord Pointer Source #

Instance details

Defined in Data.Aeson.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 #

type Rep Pointer Source #

Instance details

Defined in Data.Aeson.Pointer

type Rep Pointer = D1 ('MetaData "Pointer" "Data.Aeson.Pointer" "aeson-diff-1.1.0.13-4Ya90qLVgTyEUPMnzN8rMx" 'True) (C1 ('MetaCons "Pointer" 'PrefixI 'True) (S1 ('MetaSel ('Just "pointerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Path)))

data Key Source #

Path components to traverse a single layer of a JSON document.

Constructors

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

Instances

Instances details

FromJSON Key Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

parseJSON :: Value -> Parser Key #

parseJSONList :: Value -> Parser [Key] #

omittedField :: Maybe Key #

ToJSON Key Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

toJSON :: Key -> Value #

toEncoding :: Key -> Encoding #

toJSONList :: [Key] -> Value #

toEncodingList :: [Key] -> Encoding #

omitField :: Key -> Bool #

Generic Key Source #

Instance details

Defined in Data.Aeson.Pointer

Associated Types

type Rep Key

Instance details

Defined in Data.Aeson.Pointer

type Rep Key = D1 ('MetaData "Key" "Data.Aeson.Pointer" "aeson-diff-1.1.0.13-4Ya90qLVgTyEUPMnzN8rMx" 'False) (C1 ('MetaCons "OKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)) :+: C1 ('MetaCons "AKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: Key -> Rep Key x #

to :: Rep Key x -> Key #

Show Key Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

showsPrec :: Int -> Key -> ShowS #

show :: Key -> String #

showList :: [Key] -> ShowS #

Eq Key Source #

Instance details

Defined in Data.Aeson.Pointer

Methods

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

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

Ord Key Source #

Instance details

Defined in Data.Aeson.Pointer

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 #

type Rep Key Source #

Instance details

Defined in Data.Aeson.Pointer

type Rep Key = D1 ('MetaData "Key" "Data.Aeson.Pointer" "aeson-diff-1.1.0.13-4Ya90qLVgTyEUPMnzN8rMx" 'False) (C1 ('MetaCons "OKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)) :+: C1 ('MetaCons "AKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data Operation Source #

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.

Instances

Instances details

FromJSON Operation Source #

Instance details

Defined in Data.Aeson.Patch

Methods

parseJSON :: Value -> Parser Operation #

parseJSONList :: Value -> Parser [Operation] #

omittedField :: Maybe Operation #

ToJSON Operation Source #

Instance details

Defined in Data.Aeson.Patch

Methods

toJSON :: Operation -> Value #

toEncoding :: Operation -> Encoding #

toJSONList :: [Operation] -> Value #

toEncodingList :: [Operation] -> Encoding #

omitField :: Operation -> Bool #

Generic Operation Source #

Instance details

Defined in Data.Aeson.Patch

Associated Types

type Rep Operation

Instance details

Defined in Data.Aeson.Patch

Methods

from :: Operation -> Rep Operation x #

to :: Rep Operation x -> Operation #

Show Operation Source #

Instance details

Defined in Data.Aeson.Patch

Methods

showsPrec :: Int -> Operation -> ShowS #

show :: Operation -> String #

showList :: [Operation] -> ShowS #

Eq Operation Source #

Instance details

Defined in Data.Aeson.Patch

Methods

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

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

type Rep Operation Source #

Instance details

Defined in Data.Aeson.Patch

newtype Config Source #

Configuration for the diff algorithm.

Constructors

Config
Fields configTstBeforeRem :: Bool

Functions

diff :: Value -> Value -> Patch Source #

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

Uses the defaultConfig.

diff' :: Config -> 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.

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

Apply an Operation to a Value.

Add	http://tools.ietf.org/html/rfc6902#section-4.1
Fields changePointer :: Pointer changeValue :: Value
Cpy Pointer Pointer	http://tools.ietf.org/html/rfc6902#section-4.5
Mov Pointer Pointer	http://tools.ietf.org/html/rfc6902#section-4.4
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