Documentation
¶
Overview ¶
Package xpath provides tree walking for the DOM with XPath syntax.
BSD License ¶
Copyright (c) 2017–20, Norbert Pillmayer ¶
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of this software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NodeExtractorFunc ¶
type NodeExtractorFunc func(xpath.NodeNavigator) (*tree.Node, error)
NodeExtractorFunc is a supporting function to get the current node from an xpath.NodeNavigator.
type XPath ¶
type XPath struct {
// contains filtered or unexported fields
}
XPath is used to select nodes of a styled tree by XPath expressions.
func NewXPath ¶
func NewXPath(nav xpath.NodeNavigator, extract NodeExtractorFunc) (*XPath, error)
NewXPath creates a new XPath walker for a styled tree, with the root wrapped into an xpath.NodeNavigator. extract is used to extract the current tree node (cursor position) from the NodeNavigator. The extract function is required to be able to handle a NodeNavigator of the type underlying nav.
func (*XPath) Each ¶
Each searches the styled tree and calls a callback on each node. If brkOnErr (break on error) is set, Each will stop traversing the nodes and return immediately, as soon as callback returns an error. If brkOnErr is set to false, Each will return the last non-nil error returned by the callback function, after calling callback for each selected node.
Source Files