tree

Documentation

Index

• Variables
• func FixLineColumn(n Node, source []byte)
• type Key
• type Leaf
  • func (k Leaf) Get(ctx path.ContextPath) (Node, error)
• type MapNode
  • func (m MapNode) Get(cxt path.ContextPath) (Node, error)
• type Marker
  • func MarkerFromIndices(start, end int64) Marker
  • func (m Marker) End() (int64, int64)
  • func (marker Marker) GetMarker() Marker
  • func (m Marker) Start() (int64, int64)
  • func (m Marker) String() string
• type Node
• type Pos
• type SliceNode
  • func (s SliceNode) Get(ctx path.ContextPath) (Node, error)

Variables

var (
	ErrBadPath = errors.New("invalid path")
)

Functions

func FixLineColumn

func FixLineColumn(n Node, source []byte)

FixLineColumn populates the Line and Column of nodes that only have Index set.

Types

type Key

type Key string

Key is used to differentiate leaves describing the start and end of where a key starts and where a value starts.

type Leaf

type Leaf struct {
	Marker
}

func (Leaf) Get

func (k Leaf) Get(ctx path.ContextPath) (Node, error)

type MapNode

type MapNode struct {
	Marker
	Children map[string]Node
	Keys     map[string]Leaf
}

func (MapNode) Get

func (m MapNode) Get(cxt path.ContextPath) (Node, error)

type Marker

type Marker struct {
	StartP *Pos
	EndP   *Pos
}

Markers are composed of information regarding the start and end of where a Node exists in its source.

func MarkerFromIndices

func MarkerFromIndices(start, end int64) Marker

func (Marker) End

func (m Marker) End() (int64, int64)

func (Marker) GetMarker

func (marker Marker) GetMarker() Marker

func (Marker) Start

func (m Marker) Start() (int64, int64)

func (Marker) String

func (m Marker) String() string

type Node

type Node interface {
	Start() (int64, int64) // line, col
	End() (int64, int64)
	Get(cxt path.ContextPath) (Node, error)
	GetMarker() Marker
	// contains filtered or unexported methods
}

Node is generic representation of a json or yaml node.

type Pos

type Pos struct {
	Index  int64
	Line   int64
	Column int64
}

Pos represents a single location in a string.

type SliceNode

type SliceNode struct {
	Marker
	Children []Node
}

func (SliceNode) Get

func (s SliceNode) Get(ctx path.ContextPath) (Node, error)