syntax

package
v0.342.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2026 License: Apache-2.0 Imports: 54 Imported by: 7

Documentation

Overview

AUTOGENERATED. DO NOT EDIT.

Index

Constants

View Source
const (
	// ModuleDir contains all the module files in a bundled scripts.
	ModuleDir = "/module"

	// NoModuleDir contains all the module files without root in a bundled scripts.
	NoModuleDir = "/unnamed"

	// BundleConfig contains configurations to run a bundled scripts.
	BundleConfig = "/config.arrai"
)
View Source
const ModuleRootSentinel = "go.mod"

ModuleRootSentinel is a file which marks the module root of a project.

View Source
const NoPath = "\000"

Variables

This section is empty.

Functions

func AssertCodeErrors

func AssertCodeErrors(t *testing.T, errString, code string) bool

AssertCodeErrors asserts that code fails with a certain message when executed.

func AssertCodeEvalsToGrammar added in v0.73.0

func AssertCodeEvalsToGrammar(t *testing.T, expected parser.Grammar, code string)

AssertCodeEvalsToGrammar asserts that code evaluates to a grammar equal to expected.

func AssertCodeEvalsToType

func AssertCodeEvalsToType(t *testing.T, expected interface{}, code string) bool

AssertCodeEvalsToType asserts that code evaluates to the same type as expected.

func AssertCodePanics

func AssertCodePanics(t *testing.T, code string) bool

AssertCodePanics asserts that code panics when executed. TODO: Remove this. Should only intentionally panic for implementation bugs.

func AssertCodeParseErrors added in v0.179.0

func AssertCodeParseErrors(t *testing.T, errString, code string) bool

AssertCodeParseErrors asserts that code fails with a certain message when parsed.

func AssertCodesEvalToSameValue

func AssertCodesEvalToSameValue(t *testing.T, expected, code string) bool

AssertCodesEvalToSameValue asserts that code evaluate to the same value as expected.

func AssertCodesEvalToSameValueCtx added in v0.184.0

func AssertCodesEvalToSameValueCtx(ctx context.Context, t *testing.T, expected, code string) bool

AssertCodesEvalToSameValueCtx asserts that code evaluate to the same value as expected under the given context.

func AssertEvalExprString added in v0.3.0

func AssertEvalExprString(t *testing.T, expected, source string) bool

AssertEvalExprString asserts Expr string.

func Compile

func Compile(ctx context.Context, filePath, source string) (rel.Expr, error)

Compile compiles source string.

func EvalWithScope

func EvalWithScope(ctx context.Context, path, source string, scope rel.Scope) (rel.Value, error)

func EvaluateBundle added in v0.161.0

func EvaluateBundle(bundle []byte, args ...string) (rel.Value, error)

EvaluateBundle evaluates the buffer of a bundled scripts using the arrai bundle cmd. If args are provided, they override the values of //os.args.

func EvaluateBundleCtx added in v0.184.0

func EvaluateBundleCtx(ctx context.Context, bundle []byte, args ...string) (rel.Value, error)

EvaluateBundleCtx evaluates the buffer of a bundled scripts using the arrai bundle cmd. If args are provided, they override the values of //os.args.

func EvaluateExpr

func EvaluateExpr(ctx context.Context, path, source string) (rel.Value, error)

EvaluateExpr evaluate the passed in arrai script `source` and returns the evaluated arrai value. Parameter `path` is used as source context, could be empty.

func FixFuncs added in v0.3.0

func FixFuncs() (rel.Value, rel.Value)

func GetBuildInfo added in v0.103.0

func GetBuildInfo(b buildinfo.BuildData) rel.Value

GetBuildInfo returns arr.ai build information.

func GetMainBundleSource added in v0.161.0

func GetMainBundleSource(ctx context.Context) (context.Context, []byte, string)

GetMainBundleSource gets the path for the main arrai script in the bundled arrai scripts.

func GetModuleFromBundle added in v0.173.0

func GetModuleFromBundle(ctx context.Context, buf []byte) (context.Context, string, error)

GetModuleFromBundle fetches the module path of the bundle from the bundle's buffer.

func LoadCompiledPlan added in v0.340.0

func LoadCompiledPlan(ctx context.Context) (*rel.Plan, error)

LoadCompiledPlan reads /plan.bin from a running bundle, or nil if absent.

func MustAbs added in v0.161.0

func MustAbs(t *testing.T, filePath string) string

func MustCompile

func MustCompile(ctx context.Context, filePath, source string) rel.Expr

func NewPackageExpr

func NewPackageExpr(scanner parser.Scanner, a rel.Expr) rel.Expr

NewPackageExpr evaluates to !a.

func OutputArraiz added in v0.161.0

func OutputArraiz(ctx context.Context, w io.Writer) error

OutputArraiz writes the zip binary to the provided writer.

func PrettifyString added in v0.102.0

func PrettifyString(val interface{}, indentsNum int) (string, error)

PrettifyString returns a string which represents `rel.Value` with more reabable format. For example, `{b: 2, a: 1, c: (a: 2, b: {aa: {bb: (a: 22, d: {3, 1, 2})}})}` is formatted to:

{
	b: 2,
	a: 1,
	c: (
		a: 2,
		b: {
			aa: {
				bb: (
					a: 22,
					d: {3, 1, 2}
				)
			}
		}
	)
}

func RequireCodesEvalToSameValue

func RequireCodesEvalToSameValue(t *testing.T, expected string, code string)

RequireCodesEvalToSameValue requires that code evaluates to the same value as expected.

func SafeStdScope added in v0.274.0

func SafeStdScope() rel.Scope

func SafeStdScopeTuple added in v0.274.0

func SafeStdScopeTuple() rel.Tuple

func SetupBundle added in v0.161.0

func SetupBundle(ctx context.Context, filePath string, source []byte) (_ context.Context, err error)

SetupBundle adds necessary values to the context for bundling arrai scripts.

func StdScope

func StdScope() rel.Scope

func WithBundleRun added in v0.161.0

func WithBundleRun(ctx context.Context, buf []byte) (context.Context, error)

WithBundleRun adds necessary values to the context to allow running bundled arrai scripts.

func WriteCompiledPlan added in v0.340.0

func WriteCompiledPlan(ctx context.Context, expr rel.Expr) error

WriteCompiledPlan adds /plan.bin to the bundle zip (🎯T25).

Types

type Enumerable added in v0.117.0

type Enumerable interface {
	ArrayEnumerator() rel.ValueEnumerator
}

type EvalConfig added in v0.274.0

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

type ImportExpr added in v0.146.0

type ImportExpr struct {
	rel.ExprScanner
	// contains filtered or unexported fields
}

func NewImportExpr added in v0.146.0

func NewImportExpr(scanner parser.Scanner, imported rel.Expr, path string) ImportExpr

func (ImportExpr) Eval added in v0.146.0

func (i ImportExpr) Eval(ctx context.Context, _ rel.Scope) (rel.Value, error)

func (ImportExpr) String added in v0.146.0

func (i ImportExpr) String() string

type Macro added in v0.73.0

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

Macro represents the metadata of a macro invocation: the grammar and rule to parse with, and the transform to apply to the parsed body.

type MacroValue added in v0.73.0

type MacroValue struct {
	ast.Extra
	// contains filtered or unexported fields
}

MacroValue is an Extra node with an Expr value and a Scanner for the macro source.

func NewMacroValue added in v0.73.0

func NewMacroValue(expr rel.Expr, scanner parser.Scanner) MacroValue

NewMacroValue returns a MacroValue with a given Expr and Scanner.

func (MacroValue) Scanner added in v0.73.0

func (m MacroValue) Scanner() parser.Scanner

Scanner returns a scanner of the source that was replaced by the macro.

func (MacroValue) SubExpr added in v0.73.0

func (m MacroValue) SubExpr() rel.Expr

SubExpr returns the Expr resulting from evaluating the macro.

type PackageExpr

type PackageExpr struct {
	rel.ExprScanner
	// contains filtered or unexported fields
}

PackageExpr represents a range of operators.

func (PackageExpr) Arg

func (e PackageExpr) Arg() rel.Expr

Arg returns the PackageExpr's arg.

func (PackageExpr) Eval

func (e PackageExpr) Eval(ctx context.Context, scope rel.Scope) (rel.Value, error)

Eval returns the subject

func (PackageExpr) String

func (e PackageExpr) String() string

String returns a string representation of the expression.

type ParseContext

type ParseContext struct {
	SourceDir string
}

func (ParseContext) CompileExpr

func (pc ParseContext) CompileExpr(ctx context.Context, b ast.Branch) (rel.Expr, error)

func (ParseContext) MustParse

func (pc ParseContext) MustParse(ctx context.Context, s *parser.Scanner) ast.Branch

MustParse parses input and returns the parsed Expr or panics.

func (ParseContext) MustParseString

func (pc ParseContext) MustParseString(ctx context.Context, s string) ast.Branch

MustParseString parses input string and returns the parsed Expr or panics.

func (ParseContext) Parse

func (pc ParseContext) Parse(ctx context.Context, s *parser.Scanner) (ast.Branch, error)

Parse parses input and returns the parsed Expr or an error.

type StopError added in v0.238.0

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

func (StopError) Error added in v0.238.0

func (e StopError) Error() string

func (StopError) IsStopError added in v0.238.0

func (StopError) IsStopError()

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL