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")
ErrExpectedObject = errors.New("invalid value, expected object")
)
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(a, b []byte) bool
Equal indicates if 2 JSON documents have the same structural equality.
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(docData, patchData []byte) ([]byte, error)
MergePatch merges the patchData into the docData.
AccumulatedCopySizeError is an error type returned when the accumulated size increase caused by copy operations in a patch operation has exceeded the limit.
type AccumulatedCopySizeError struct {
// contains filtered or unexported fields
}
func NewAccumulatedCopySizeError(l, a int64) *AccumulatedCopySizeError
NewAccumulatedCopySizeError returns an AccumulatedCopySizeError.
func (a *AccumulatedCopySizeError) Error() string
Error implements the error interface.
ApplyOptions specifies options for calls to ApplyWithOptions. Use NewApplyOptions to obtain default values for ApplyOptions.
type ApplyOptions struct {
// 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
// AccumulatedCopySizeLimit limits the total size increase in bytes caused by
// "copy" operations in a patch.
AccumulatedCopySizeLimit int64
// AllowMissingPathOnRemove indicates whether to fail "remove" operations when the target path is missing.
// Default to false.
AllowMissingPathOnRemove bool
// EnsurePathExistsOnAdd instructs json-patch to recursively create the missing parts of path on "add" operation.
// Default to false.
EnsurePathExistsOnAdd bool
EscapeHTML bool
}
func NewApplyOptions() *ApplyOptions
NewApplyOptions creates a default set of options for calls to ApplyWithOptions.
ArraySizeError is an error type returned when the array size has exceeded the limit.
type ArraySizeError struct {
// contains filtered or unexported fields
}
func NewArraySizeError(l, s int) *ArraySizeError
NewArraySizeError returns an ArraySizeError.
func (a *ArraySizeError) Error() string
Error implements the error interface.
Operation is a single JSON-Patch step, such as a single 'add' operation.
type Operation map[string]*json.RawMessage
func (o Operation) From() (string, error)
From reads the "from" field of the Operation.
func (o Operation) Kind() string
Kind reads the "op" field of the Operation.
func (o Operation) Path() (string, error)
Path reads the "path" field of the Operation.
func (o Operation) ValueInterface() (interface{}, error)
ValueInterface decodes the operation value into an interface.
Patch is an ordered collection of Operations.
type Patch []Operation
func DecodePatch(buf []byte) (Patch, error)
DecodePatch decodes the passed JSON document as an RFC 6902 patch.
func (p Patch) Apply(doc []byte) ([]byte, error)
Apply mutates a JSON document according to the patch, and returns the new document.
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.
func (p Patch) ApplyIndentWithOptions(doc []byte, indent string, options *ApplyOptions) ([]byte, error)
ApplyIndentWithOptions mutates a JSON document according to the patch and the passed in ApplyOptions. It returns the new document indented.
func (p Patch) ApplyWithOptions(doc []byte, options *ApplyOptions) ([]byte, error)
ApplyWithOptions mutates a JSON document according to the patch and the passed in ApplyOptions. It returns the new document.
| Name | Synopsis |
|---|---|
| .. | |
| cmd | |
| json-patch | |