rego

Documentation

Index

• func AllKeywords(ctx context.Context, fileName, contents string, module *ast.Module) (map[string][]KeywordUse, error)
• func BuiltinCategory(builtin *ast.Builtin) (category string)
• func GetBuiltins() map[string]*ast.Builtin
• func LocationFromPosition(pos types.Position) *ast.Location
• func PositionFromLocation(loc *ast.Location) types.Position
• func QueryRegalBundle(input map[string]any, pq rego.PreparedEvalQuery) (map[string]any, error)
• func SetInputContext(input map[string]any, context map[string]any) map[string]any
• func ToInput(fileURI string, cid clients.Identifier, content string, context map[string]any) (map[string]any, error)
• func UpdateBuiltins(caps *ast.Capabilities)
• type BuiltInCall
  • func AllBuiltinCalls(module *ast.Module) []BuiltInCall
• type KeywordUse
• type KeywordUseLocation
• type RuleHeads
  • func AllRuleHeadLocations(ctx context.Context, fileName, contents string, module *ast.Module) (RuleHeads, error)

Functions

func AllKeywords

func AllKeywords(ctx context.Context, fileName, contents string, module *ast.Module) (map[string][]KeywordUse, error)

AllKeywords returns all keywords in the module.

func BuiltinCategory

func BuiltinCategory(builtin *ast.Builtin) (category string)

func GetBuiltins

func GetBuiltins() map[string]*ast.Builtin

func LocationFromPosition

func LocationFromPosition(pos types.Position) *ast.Location

func PositionFromLocation

func PositionFromLocation(loc *ast.Location) types.Position

func QueryRegalBundle

func QueryRegalBundle(input map[string]any, pq rego.PreparedEvalQuery) (map[string]any, error)

func SetInputContext

func SetInputContext(input map[string]any, context map[string]any) map[string]any

func ToInput

func ToInput(
	fileURI string,
	cid clients.Identifier,
	content string,
	context map[string]any,
) (map[string]any, error)

ToInput prepares a module with Regal additions to be used as input for evaluation.

func UpdateBuiltins

func UpdateBuiltins(caps *ast.Capabilities)

Update updates the builtins database with the provided capabilities.

Types

type BuiltInCall

type BuiltInCall struct {
	Builtin  *ast.Builtin
	Location *ast.Location
	Args     []*ast.Term
}

func AllBuiltinCalls

func AllBuiltinCalls(module *ast.Module) []BuiltInCall

AllBuiltinCalls returns all built-in calls in the module, excluding operators and any other function identified by an infix.

type KeywordUse

type KeywordUse struct {
	Name     string             `json:"name"`
	Location KeywordUseLocation `json:"location"`
}

type KeywordUseLocation

type KeywordUseLocation struct {
	Row uint `json:"row"`
	Col uint `json:"col"`
}

type RuleHeads

type RuleHeads map[string][]*ast.Location

func AllRuleHeadLocations

func AllRuleHeadLocations(ctx context.Context, fileName, contents string, module *ast.Module) (RuleHeads, error)

AllRuleHeadLocations returns mapping of rules names to the head locations.