patch

Documentation

Overview

Package patch provides an implementation of the IPLD Patch specification. IPLD Patch is a system for declaratively specifying patches to a document, which can then be applied to produce a new, modified document.

This package is EXPERIMENTAL; its behavior and API might change as it's still in development.

Index

• Constants
• func Eval(n datamodel.Node, ops []Operation) (datamodel.Node, error)
• func EvalOne(n datamodel.Node, op Operation) (datamodel.Node, error)
• type Op
• type Operation
  • func Parse(r io.Reader, dec codec.Decoder) ([]Operation, error)
  • func ParseBytes(b []byte, dec codec.Decoder) ([]Operation, error)

Constants

const (
	Op_Add     = "add"
	Op_Remove  = "remove"
	Op_Replace = "replace"
	Op_Move    = "move"
	Op_Copy    = "copy"
	Op_Test    = "test"
)

Functions

func Eval

func Eval(n datamodel.Node, ops []Operation) (datamodel.Node, error)

func EvalOne

func EvalOne(n datamodel.Node, op Operation) (datamodel.Node, error)

Types

type Op

type Op string

type Operation

type Operation struct {
	Op    Op             // Always required.
	Path  datamodel.Path // Always required.
	Value datamodel.Node // Present on 'add', 'replace', 'test'.
	From  datamodel.Path // Present on 'move', 'copy'.
}

func Parse

func Parse(r io.Reader, dec codec.Decoder) ([]Operation, error)

func ParseBytes

func ParseBytes(b []byte, dec codec.Decoder) ([]Operation, error)