arg_parser

package

v0.0.0-...-f7fa24c Latest Latest Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 10 Imported by: 42

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Utility functions for extracting and validating inputs to functions and plugins.

This section is empty.

This section is empty.

func ExtractArgs(scope types.Scope, args *ordereddict.Dict, target interface{}) error

Deprecate this in favor of ExtractArgsWithContext

func ExtractArgsWithContext(
	ctx context.Context, scope types.Scope, args *ordereddict.Dict, target interface{}) error

func GetStringArg(
	ctx context.Context, scope types.Scope, args *ordereddict.Dict, field string) string

func RegisterParser(exemplar types.Any, parser ParserDipatcher)

func ToLazyExpr(scope types.Scope, arg types.Any) types.LazyExpr

Wrap an arg in a LazyExpr for plugins that want to receive a LazyExpr.

func ToStoredQuery(ctx context.Context, arg types.Any) types.StoredQuery

Convert a type to a stored query

type FieldParser struct {
	Field    string
	FieldIdx int
	Required bool
	Parser   ParserDipatcher
}

type LazyExpressionWrapper struct {
	// contains filtered or unexported fields
}

func (self *LazyExpressionWrapper) Delegate() types.Any

func (self *LazyExpressionWrapper) Reduce(ctx context.Context) types.Any

func (self *LazyExpressionWrapper) ReduceWithScope(ctx context.Context, scope types.Scope) types.Any

type Parser struct {
	Fields []*FieldParser
}

func BuildParser(v reflect.Value) (*Parser, error)

Builds a cacheable parser that can parse into

func GetParser(target reflect.Value) (*Parser, error)

func (self *Parser) Parse(
	ctx context.Context, scope types.Scope, args *ordereddict.Dict, target reflect.Value) error

type ParserDipatcher func(ctx context.Context,
	scope types.Scope, args *ordereddict.Dict,
	value interface{}) (interface{}, error)

type StoredQueryWrapperLazyExpression struct {
	// contains filtered or unexported fields
}

Wrap a Stored Query with a LazyExpr interface. Callers will receive the Stored Query when reducing us.

func (self *StoredQueryWrapperLazyExpression) Delegate() types.StoredQuery

func (self *StoredQueryWrapperLazyExpression) Reduce(ctx context.Context) types.Any

func (self *StoredQueryWrapperLazyExpression) ReduceWithScope(
	ctx context.Context, scope types.Scope) types.Any