debug

Documentation

Overview

Package debug provides tools to print a parsed expression graph and adorn each expression element with additional metadata.

Index

• func ToAdornedDebugString(e *expr.Expr, adorner DebugAdorner) string
• func ToDebugString(e *expr.Expr) string
• type DebugAdorner
• type DebugWriter

Functions

func ToAdornedDebugString

func ToAdornedDebugString(e *expr.Expr, adorner DebugAdorner) string

func ToDebugString

func ToDebugString(e *expr.Expr) string

Types

type DebugAdorner

type DebugAdorner interface {
	// GetMetadata for the input context.
	GetMetadata(ctx interface{}) string
}

DebugAdorner returns debug metadata that will be tacked on to the string representation of an expression.

type DebugWriter

type DebugWriter interface {
	fmt.Stringer

	// Buffer pushes an expression into an internal queue of expressions to
	// write to a string.
	Buffer(e *expr.Expr)
}

DebugWriter manages writing expressions to an internal string.