package jsonpatch

import "github.com/evanphx/json-patch"

Index ¶

• Variables
• func CreateMergePatch(originalJSON, modifiedJSON []byte) ([]byte, error)
• func Equal(a, b []byte) bool
• func MergeMergePatches(patch1Data, patch2Data []byte) ([]byte, error)
• func MergePatch(docData, patchData []byte) ([]byte, error)
• type AccumulatedCopySizeError
• func NewAccumulatedCopySizeError(l, a int64) *AccumulatedCopySizeError
• func (a *AccumulatedCopySizeError) Error() string
• type ArraySizeError
• func NewArraySizeError(l, s int) *ArraySizeError
• func (a *ArraySizeError) Error() string
• type Operation
• func (o Operation) From() (string, error)
• func (o Operation) Kind() string
• func (o Operation) Path() (string, error)
• func (o Operation) ValueInterface() (interface{}, error)
• type Patch
• func DecodePatch(buf []byte) (Patch, error)
• func (p Patch) Apply(doc []byte) ([]byte, error)
• func (p Patch) ApplyIndent(doc []byte, indent string) ([]byte, error)

Variables ¶

var (
	// SupportNegativeIndices decides whether to support non-standard practice of
	// allowing negative indices to mean indices starting at the end of an array.
	// Default to true.
	SupportNegativeIndices bool = true
	// AccumulatedCopySizeLimit limits the total size increase in bytes caused by
	// "copy" operations in a patch.
	AccumulatedCopySizeLimit int64 = 0
)

var (
	ErrTestFailed   = errors.New("test failed")
	ErrMissing      = errors.New("missing value")
	ErrUnknownType  = errors.New("unknown object type")
	ErrInvalid      = errors.New("invalid state detected")
	ErrInvalidIndex = errors.New("invalid index referenced")
)

var ErrBadJSONDoc = fmt.Errorf("Invalid JSON Document")

var ErrBadJSONPatch = fmt.Errorf("Invalid JSON Patch")

Functions ¶

func CreateMergePatch ¶

func CreateMergePatch(originalJSON, modifiedJSON []byte) ([]byte, error)

CreateMergePatch will return a merge patch document capable of converting the original document(s) to the modified document(s). The parameters can be bytes of either two JSON Documents, or two arrays of JSON documents. The merge patch returned follows the specification defined at http://tools.ietf.org/html/draft-ietf-appsawg-json-merge-patch-07

func Equal ¶

func Equal(a, b []byte) bool

Equal indicates if 2 JSON documents have the same structural equality.

func MergeMergePatches ¶

func MergeMergePatches(patch1Data, patch2Data []byte) ([]byte, error)

MergeMergePatches merges two merge patches together, such that applying this resulting merged merge patch to a document yields the same as merging each merge patch to the document in succession.

func MergePatch ¶

func MergePatch(docData, patchData []byte) ([]byte, error)

MergePatch merges the patchData into the docData.

Types ¶

type AccumulatedCopySizeError ¶

type AccumulatedCopySizeError struct {
	// contains filtered or unexported fields
}

AccumulatedCopySizeError is an error type returned when the accumulated size increase caused by copy operations in a patch operation has exceeded the limit.

func NewAccumulatedCopySizeError ¶

func NewAccumulatedCopySizeError(l, a int64) *AccumulatedCopySizeError

NewAccumulatedCopySizeError returns an AccumulatedCopySizeError.

func (*AccumulatedCopySizeError) Error ¶

func (a *AccumulatedCopySizeError) Error() string

Error implements the error interface.

type ArraySizeError ¶

type ArraySizeError struct {
	// contains filtered or unexported fields
}

ArraySizeError is an error type returned when the array size has exceeded the limit.

func NewArraySizeError ¶

func NewArraySizeError(l, s int) *ArraySizeError

NewArraySizeError returns an ArraySizeError.

func (*ArraySizeError) Error ¶

func (a *ArraySizeError) Error() string

Error implements the error interface.

type Operation ¶

type Operation map[string]*json.RawMessage

Operation is a single JSON-Patch step, such as a single 'add' operation.

func (Operation) From ¶

func (o Operation) From() (string, error)

From reads the "from" field of the Operation.

func (Operation) Kind ¶

func (o Operation) Kind() string

Kind reads the "op" field of the Operation.

func (Operation) Path ¶

func (o Operation) Path() (string, error)

Path reads the "path" field of the Operation.

func (Operation) ValueInterface ¶

func (o Operation) ValueInterface() (interface{}, error)

ValueInterface decodes the operation value into an interface.

type Patch ¶

type Patch []Operation

Patch is an ordered collection of Operations.

func DecodePatch ¶

func DecodePatch(buf []byte) (Patch, error)

DecodePatch decodes the passed JSON document as an RFC 6902 patch.

func (Patch) Apply ¶

func (p Patch) Apply(doc []byte) ([]byte, error)

Apply mutates a JSON document according to the patch, and returns the new document.

func (Patch) ApplyIndent ¶

func (p Patch) ApplyIndent(doc []byte, indent string) ([]byte, error)

ApplyIndent mutates a JSON document according to the patch, and returns the new document indented.

Source Files ¶

errors.go merge.go patch.go

Directories ¶