package parse

Import Path
	github.com/carapace-sh/carapace/third_party/github.com/drone/envsubst/parse (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    node.go
	    parse.go
	    scan.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type FuncNode (struct)
		FuncNode represents a string function.

		Fields (total 3)
			Args []Node
			Name string
			Param string
		Implements (at least one exported)
			*FuncNode : Node

	 type ListNode (struct)
		ListNode represents a list of nodes.

		Fields (only one)
			Nodes []Node
		Implements (at least one exported)
			*ListNode : Node

	 type Node (interface)
		Node is an element in the parse tree.

		Implemented By (at least 3)
			*FuncNode
			*ListNode
			*TextNode

	 type TextNode (struct)
		TextNode represents a string of text.

		Fields (only one)
			Value string
		Implements (at least one exported)
			*TextNode : Node

	 type Tree (struct)
		Tree is the representation of a single parsed SQL statement.

		Fields (only one)
			Root Node
		Methods (only one)
			(*Tree) Parse(buf string) (tree *Tree, err error)
				Parse parses the string buffer to construct an ast
				representation for expansion.

		As Outputs Of (at least 2)
			func Parse(buf string) (*Tree, error)
			func (*Tree).Parse(buf string) (tree *Tree, err error)


Package-Level Functions (only one)

	 func Parse(buf string) (*Tree, error)
		Parse parses the string and returns a Tree.


Package-Level Variables (total 5)

	  var ErrBadSubstitution error
		ErrBadSubstitution represents a substitution parsing error.

	  var ErrMissingClosingBrace error
		ErrMissingClosingBrace represents a missing closing brace "}" error.

	  var ErrParseDefaultFunction error
		ErrParseDefaultFunction represent the error when unable to parse a
		default function.

	  var ErrParseFuncSubstitution error
		ErrParseFuncSubstitution represents the error when unable to parse the
		substitution within a function parameter.

	  var ErrParseVariableName error
		ErrParseVariableName represents the error when unable to parse a
		variable name within a substitution.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.