ytwalk

Documentation

Overview

Package ytwalk implements cypress traversal.

Index

• Variables
• func Do(ctx context.Context, yc yt.Client, w *Walk) error
• type Walk

Variables

var ErrSkipSubtree = errors.New("skip subtree")

ErrSkipSubtree is sentinel value returned from OnNode.

Functions

func Do

func Do(ctx context.Context, yc yt.Client, w *Walk) error

Types

type Walk

type Walk struct {
	// Root is cypress path where walk starts.
	Root ypath.Path

	// Attributes are requested for each node.
	Attributes []string

	// Node is optional pointer to type that will hold deserialized cypress node.
	Node interface{}

	// OnNode is invoked for each node during traversal.
	OnNode func(path ypath.Path, node interface{}) error

	// RespectOpaque defines whether we stop at opaque nodes (true) or not (false).
	RespectOpaque bool
}