mutation

Documentation

Index

• Constants
• Variables
• type Mutation
  • func New(ops []*Operation, parents []string) *Mutation
  • func (s *Mutation) FromObject(o object.Object) error
  • func (s Mutation) GetType() string
  • func (c Mutation) Mutate(o object.Object) error
  • func (s Mutation) ToObject() object.Object
• type Operation
  • func (c Operation) Apply(o object.Object) error

Constants

const (
	// OpAppend ...
	OpAppend = "append"
	// OpAssign ...
	OpAssign = "assign"
	// OpDelete ...
	OpDelete = "delete"
)

const (
	MutationType = "/object.mutation"
)

Variables

var (
	ErrParsingCursor     = errors.New("could not parse cursor")
	ErrNotImplemented    = errors.New("operation not implemented")
	ErrApplyingOperation = errors.New("could not apply operation")
)

Types

type Mutation

type Mutation struct {
	Operations []*Operation `json:"ops:ao"`
	Root       string       `json:"@root:s"`
	Parents    []string     `json:"@parents:as"`
}

Mutation provides operations to be applied given that the parent mutations have already been applied

func New

func New(ops []*Operation, parents []string) *Mutation

New construct a mutation from an array of operations and parrent chains

func (*Mutation) FromObject

func (s *Mutation) FromObject(o object.Object) error

FromObject populates the struct from a f12n object

func (Mutation) GetType

func (s Mutation) GetType() string

GetType returns the object's type

func (Mutation) Mutate

func (c Mutation) Mutate(o object.Object) error

Mutate applies the mutation's operations on the given object

func (Mutation) ToObject

func (s Mutation) ToObject() object.Object

ToObject returns a f12n object

type Operation

type Operation struct {
	Operation string      `json:"op:s"`
	Cursor    []string    `json:"cursor:as"`
	Value     interface{} `json:"value"`
}

Operation ...

func (Operation) Apply

func (c Operation) Apply(o object.Object) error

Apply ...