query

Documentation

Overview

query handles finding a match in a tree, but not unmarshaling the node. This package should not generally be used directly.

Index

• func QueryAll(doc ast.Node, source []byte, query []match.Node, extractor match.Node) (found []ast.Node, err error)
• func QueryOne(doc ast.Node, source []byte, query []match.Node) (found ast.Node, err error)
• type QueryError
  • func (e *QueryError) Error() string

Functions

func QueryAll

func QueryAll(doc ast.Node, source []byte, query []match.Node, extractor match.Node) (found []ast.Node, err error)

Use all but the last matcher in the query to find a parent node, then return a list of descendants that match the last matcher.

func QueryOne

func QueryOne(doc ast.Node, source []byte, query []match.Node) (found ast.Node, err error)

Apply a matcher to a tree, and return the matching node for unmarshaling.

Types

type QueryError

type QueryError struct {
	Matches     []match.Node
	FailedMatch match.Node
}

Error returned when a query fails to match. Includes the list of matches that were found, and the match that failed. Prints an error message that can be used to debug the query.

func (*QueryError) Error

func (e *QueryError) Error() string