runsummary

Documentation

Index

• type RunSummary
  • func New() *RunSummary
  • func NewFrom(tree pathtree.TreeData) *RunSummary
  • func (rs *RunSummary) ApplyChangeRecord(summaryRecord *service.SummaryRecord, onError func(error))
  • func (rs *RunSummary) CloneTree() (pathtree.TreeData, error)
  • func (rs *RunSummary) Flatten() ([]*service.SummaryItem, error)
  • func (rs *RunSummary) Serialize() ([]byte, error)
  • func (rs *RunSummary) Tree() pathtree.TreeData

Types

type RunSummary

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

func New

func New() *RunSummary

func NewFrom

func NewFrom(tree pathtree.TreeData) *RunSummary

func (*RunSummary) ApplyChangeRecord

func (rs *RunSummary) ApplyChangeRecord(
	summaryRecord *service.SummaryRecord,
	onError func(error),
)

Updates and/or removes values from the configuration tree.

Does a best-effort job to apply all changes. Errors are passed to `onError` and skipped.

func (*RunSummary) CloneTree

func (rs *RunSummary) CloneTree() (pathtree.TreeData, error)

Clones the tree. This is useful for creating a snapshot of the tree.

func (*RunSummary) Flatten

func (rs *RunSummary) Flatten() ([]*service.SummaryItem, error)

Flatten the summary tree into a slice of SummaryItems.

There is no guarantee for the order of the items in the slice. The order of the items is determined by the order of the tree traversal. The tree traversal is depth-first but based on a map, so the order is not guaranteed.

func (*RunSummary) Serialize

func (rs *RunSummary) Serialize() ([]byte, error)

Serializes the object to send to the backend.

func (*RunSummary) Tree

func (rs *RunSummary) Tree() pathtree.TreeData

Tree returns the tree data.