exec

Documentation

Index

• func GetCursorString(c store.Cursor) string
• func Unmarshal(result Result, value any, settings ...ContextApply) error
• type Bool
  • func (b Bool) Bool() bool
  • func (b Bool) Number() float64
  • func (b Bool) String() string
• type Context
• type ContextApply
• type ContextSettings
• type Function
• type NodeSet
  • func (n NodeSet) Bool() bool
  • func (n NodeSet) Number() float64
  • func (n NodeSet) String() string
• type Number
  • func (n Number) Bool() bool
  • func (n Number) Number() float64
  • func (n Number) String() string
• type Result
  • func Exec(cursor store.Cursor, expr *grammar.Grammar, settings ...ContextApply) (Result, error)
• type String
  • func (n String) Bool() bool
  • func (n String) Number() float64
  • func (n String) String() string
• type XmlName
  • func GetQName(input string, namespaces map[string]string) (XmlName, error)
  • func (n XmlName) String() string

Functions

func GetCursorString

func GetCursorString(c store.Cursor) string

func Unmarshal

func Unmarshal(result Result, value any, settings ...ContextApply) error

Unmarshal maps a XPath result to a struct or slice. When unmarshaling a slice, the result must be a NodeSet. When unmarshaling a struct, the result must be a NodeSet with one result. To unmarshal a value to a struct field, give it a "xsel" tag name, and a XPath expression for its value (e.g. `xsel:"//my-struct[@my-id = 'my-value']"`).

For struct fields, Unmarshal can set fields that are ints and uints, bools, strings, slices, and nested structs.

For slice elements, Unmarshal can set ints and uints, bools, strings, and structs. It cannot Unmarshal multidimensional slices.

Arrays, maps, and channels are not supported.

Types

type Bool

type Bool bool

func (Bool) Bool

func (b Bool) Bool() bool

func (Bool) Number

func (b Bool) Number() float64

func (Bool) String

func (b Bool) String() string

type Context

type Context interface {
	Result() Result
	ContextPosition() int
}

type ContextApply

type ContextApply func(c *ContextSettings)

type ContextSettings

type ContextSettings struct {
	NamespaceDecls  map[string]string
	FunctionLibrary map[XmlName]Function
	Variables       map[XmlName]Result
}

ContextSettings allows you to add namespace mappings, create new functions, and add variable bindings to your XPath query.

type Function

type Function func(context Context, args ...Result) (Result, error)

type NodeSet

type NodeSet []store.Cursor

func (NodeSet) Bool

func (n NodeSet) Bool() bool

func (NodeSet) Number

func (n NodeSet) Number() float64

func (NodeSet) String

func (n NodeSet) String() string

type Number

type Number float64

func (Number) Bool

func (n Number) Bool() bool

func (Number) Number

func (n Number) Number() float64

func (Number) String

func (n Number) String() string

type Result

type Result interface {
	String() string
	Number() float64
	Bool() bool
}

func Exec

func Exec(cursor store.Cursor, expr *grammar.Grammar, settings ...ContextApply) (Result, error)

Executes an XPath query against the given Cursor and returns the result.

type String

type String string

func (String) Bool

func (n String) Bool() bool

func (String) Number

func (n String) Number() float64

func (String) String

func (n String) String() string

type XmlName

type XmlName struct {
	Space string
	Local string
}

func GetQName

func GetQName(input string, namespaces map[string]string) (XmlName, error)

func (XmlName) String

func (n XmlName) String() string