scriptlet

package

v6.18.0 Latest Latest Go to latest Published: Oct 31, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

func Compile(programName string, src string, preDeclared []string) (*starlark.Program, error)

Compile compiles a scriptlet.

func Optional(name string) scriptletFunction

Optional is a convenience wrapper declaring an optional function.

func Required(name string) scriptletFunction

Required is a convenience wrapper declaring a required function.

func StarlarkMarshal(input any) (starlark.Value, error)

StarlarkMarshal converts input to a starlark Value. It only includes exported struct fields, and uses the "json" tag for field names.

func StarlarkUnmarshal(input starlark.Value) (any, error)

StarlarkUnmarshal converts a Starlark value into a Go value. Only NoneType, Bool, Int, Float, String, List and Dict are supported.

func Validate(compiler func(string, string) (*starlark.Program, error), programName string, src string, scriptletFunctions Declaration) error

Validate validates a scriptlet by compiling it and checking the presence of required and optional functions.

type Declaration = map[scriptletFunction][]string

Declaration is a type alias to make scriptlet declaration easier.

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

Loader holds the programs for the scriptlet.

func NewLoader() *Loader

NewLoader creates a new Loader.

func (l *Loader) Program(name string, programName string) (*starlark.Program, *starlark.Thread, error)

Program returns a precompiled scriptlet program.

func (l *Loader) Set(compiler func(string, string) (*starlark.Program, error), programName string, src string) error

Set compiles a scriptlet into memory. If empty src is provided the current program is deleted.