const (// EvalModeTopdown (default) instructs the compiler to build rule// and comprehension indices used by topdown evaluation.EvalModeTopdown =v1.EvalModeTopdown// EvalModeIR makes the compiler skip the stages for comprehension// and rule indices.EvalModeIR =v1.EvalModeIR)

const (// ParseErr indicates an unclassified parse error occurred.ParseErr =v1.ParseErr// CompileErr indicates an unclassified compile error occurred.CompileErr =v1.CompileErr// TypeErr indicates a type error was caught.TypeErr =v1.TypeErr// UnsafeVarErr indicates an unsafe variable was found during compilation.UnsafeVarErr =v1.UnsafeVarErr// RecursionErr indicates recursion was found during compilation.RecursionErr =v1.RecursionErr)

const (RegoUndefined =v1.RegoUndefined// RegoV0 is the default, original Rego syntax.RegoV0 =v1.RegoV0// RegoV0CompatV1 requires modules to comply with both the RegoV0 and RegoV1 syntax (as when 'rego.v1' is imported in a module).// Shortly, RegoV1 compatibility is required, but 'rego.v1' or 'future.keywords' must also be imported.RegoV0CompatV1 =v1.RegoV0CompatV1// RegoV1 is the Rego syntax enforced by OPA 1.0; e.g.:// future.keywords part of default keyword set, and don't require imports;// 'if' and 'contains' required in rule heads;// (some) strict checks on by default.RegoV1 =v1.RegoV1)

const (// CompleteDoc represents a document that is completely defined by the rule.CompleteDoc =v1.CompleteDoc// PartialSetDoc represents a set document that is partially defined by the rule.PartialSetDoc =v1.PartialSetDoc// PartialObjectDoc represents an object document that is partially defined by the rule.PartialObjectDoc =v1.PartialObjectDoc)

const (SingleValue =v1.SingleValueMultiValue  =v1.MultiValue)

const CompileErrorLimitDefault = 10

const DefaultRegoVersion =RegoV0

const FeatureRefHeadStringPrefixes =v1.FeatureRefHeadStringPrefixes

const FeatureRefHeads =v1.FeatureRefHeads

const FeatureRegoV1 =v1.FeatureRegoV1

const FeatureRegoV1Import =v1.FeatureRegoV1Import

const SystemDocumentKey =v1.SystemDocumentKey

const WildcardPrefix =v1.WildcardPrefix

var Abs =v1.Abs

var AddDate =v1.AddDate

var All =v1.All

var And =v1.And

var Any =v1.Any

var AnyPrefixMatch =v1.AnyPrefixMatch

var AnySuffixMatch =v1.AnySuffixMatch

var ArrayConcat =v1.ArrayConcat

var ArrayReverse =v1.ArrayReverse

var ArraySlice =v1.ArraySlice

var Assign =v1.Assign

var Base64Decode =v1.Base64Decode

var Base64Encode =v1.Base64Encode

var Base64IsValid =v1.Base64IsValid

var Base64UrlDecode =v1.Base64UrlDecode

var Base64UrlEncode =v1.Base64UrlEncode

var Base64UrlEncodeNoPad =v1.Base64UrlEncodeNoPad

var BitsAnd =v1.BitsAnd

var BitsNegate =v1.BitsNegate

var BitsOr =v1.BitsOr

var BitsShiftLeft =v1.BitsShiftLeft

var BitsShiftRight =v1.BitsShiftRight

var BitsXOr =v1.BitsXOr

var BuiltinMap =v1.BuiltinMap

var Builtins =v1.Builtins

var CastArray =v1.CastArray

var CastBoolean =v1.CastBoolean

var CastNull =v1.CastNull

var CastObject =v1.CastObject

var CastSet =v1.CastSet

var CastString =v1.CastString

var Ceil =v1.Ceil

var Clock =v1.Clock

var Concat =v1.Concat

var Contains =v1.Contains

var Count =v1.Count

var CryptoHmacEqual =v1.CryptoHmacEqual

var CryptoHmacMd5 =v1.CryptoHmacMd5

var CryptoHmacSha1 =v1.CryptoHmacSha1

var CryptoHmacSha256 =v1.CryptoHmacSha256

var CryptoHmacSha512 =v1.CryptoHmacSha512

var CryptoMd5 =v1.CryptoMd5

var CryptoParsePrivateKeys =v1.CryptoParsePrivateKeys

var CryptoSha1 =v1.CryptoSha1

var CryptoSha256 =v1.CryptoSha256

var CryptoX509ParseAndVerifyCertificates =v1.CryptoX509ParseAndVerifyCertificates

var CryptoX509ParseAndVerifyCertificatesWithOptions =v1.CryptoX509ParseAndVerifyCertificatesWithOptions

var CryptoX509ParseCertificateRequest =v1.CryptoX509ParseCertificateRequest

var CryptoX509ParseCertificates =v1.CryptoX509ParseCertificates

var CryptoX509ParseKeyPair =v1.CryptoX509ParseKeyPair

var CryptoX509ParseRSAPrivateKey =v1.CryptoX509ParseRSAPrivateKey

var Date =v1.Date

var DefaultBuiltins =v1.DefaultBuiltins

var DefaultRootDocument =v1.DefaultRootDocument

var DefaultRootRef =v1.DefaultRootRef

var Diff =v1.Diff

var Divide =v1.Divide

var EndsWith =v1.EndsWith

var Equal =v1.Equal

var Equality =v1.Equality

var Floor =v1.Floor

var Format =v1.Format

var FormatInt =v1.FormatInt

var FunctionArgRootDocument =v1.FunctionArgRootDocument

var FutureRootDocument =v1.FutureRootDocument

var GlobMatch =v1.GlobMatch

var GlobQuoteMeta =v1.GlobQuoteMeta

var GlobsMatch =v1.GlobsMatch

var GraphQLIsValid =v1.GraphQLIsValid

var GraphQLParse =v1.GraphQLParse

var GraphQLParseAndVerify =v1.GraphQLParseAndVerify

var GraphQLParseQuery =v1.GraphQLParseQuery

var GraphQLParseSchema =v1.GraphQLParseSchema

var GraphQLSchemaIsValid =v1.GraphQLSchemaIsValid

var GreaterThan =v1.GreaterThan

var GreaterThanEq =v1.GreaterThanEq

var HTTPSend =v1.HTTPSend

var HexDecode =v1.HexDecode

var HexEncode =v1.HexEncode

var IgnoreDuringPartialEval =v1.IgnoreDuringPartialEval

var IndexOf =v1.IndexOf

var IndexOfN =v1.IndexOfN

var InputRootDocument =v1.InputRootDocument

var InputRootRef =v1.InputRootRef

var InternalPrint =v1.InternalPrint

var Intersection =v1.Intersection

var IsArray =v1.IsArray

var IsBoolean =v1.IsBoolean

var IsNull =v1.IsNull

var IsNumber =v1.IsNumber

var IsObject =v1.IsObject

var IsSet =v1.IsSet

var IsString =v1.IsString

var JSONFilter =v1.JSONFilter

var JSONIsValid =v1.JSONIsValid

var JSONMarshal =v1.JSONMarshal

var JSONMarshalWithOptions =v1.JSONMarshalWithOptions

var JSONMatchSchema =v1.JSONMatchSchema

var JSONPatch =v1.JSONPatch

var JSONRemove =v1.JSONRemove

var JSONSchemaVerify =v1.JSONSchemaVerify

var JSONUnmarshal =v1.JSONUnmarshal

var JWTDecode =v1.JWTDecode

var JWTDecodeVerify =v1.JWTDecodeVerify

var JWTEncodeSign =v1.JWTEncodeSign

var JWTEncodeSignRaw =v1.JWTEncodeSignRaw

var JWTVerifyES256 =v1.JWTVerifyES256

var JWTVerifyES384 =v1.JWTVerifyES384

var JWTVerifyES512 =v1.JWTVerifyES512

var JWTVerifyHS256 =v1.JWTVerifyHS256

var JWTVerifyHS384 =v1.JWTVerifyHS384

var JWTVerifyHS512 =v1.JWTVerifyHS512

var JWTVerifyPS256 =v1.JWTVerifyPS256

var JWTVerifyPS384 =v1.JWTVerifyPS384

var JWTVerifyPS512 =v1.JWTVerifyPS512

var JWTVerifyRS256 =v1.JWTVerifyRS256

var JWTVerifyRS384 =v1.JWTVerifyRS384

var JWTVerifyRS512 =v1.JWTVerifyRS512

var Keywords =v1.Keywords

var KeywordsV0 =v1.KeywordsV0

var KeywordsV1 =v1.KeywordsV1

var LessThan =v1.LessThan

var LessThanEq =v1.LessThanEq

var Lower =v1.Lower

var Max =v1.Max

var Member =v1.Member

var MemberWithKey =v1.MemberWithKey

var Min =v1.Min

var Minus =v1.Minus

var Multiply =v1.Multiply

var NetCIDRContains =v1.NetCIDRContains

var NetCIDRContainsMatches =v1.NetCIDRContainsMatches

var NetCIDRExpand =v1.NetCIDRExpand

var NetCIDRIntersects =v1.NetCIDRIntersects

var NetCIDRIsValid =v1.NetCIDRIsValid

var NetCIDRMerge =v1.NetCIDRMerge

var NetCIDROverlap =v1.NetCIDROverlap

var NetLookupIPAddr =v1.NetLookupIPAddr

var NotEqual =v1.NotEqual

var NowNanos =v1.NowNanos

var NumbersRange =v1.NumbersRange

var NumbersRangeStep =v1.NumbersRangeStep

var OPARuntime =v1.OPARuntime

var ObjectFilter =v1.ObjectFilter

var ObjectGet =v1.ObjectGet

var ObjectKeys =v1.ObjectKeys

var ObjectRemove =v1.ObjectRemove

var ObjectSubset =v1.ObjectSubset

var ObjectUnion =v1.ObjectUnion

var ObjectUnionN =v1.ObjectUnionN

var Or =v1.Or

var ParseDurationNanos =v1.ParseDurationNanos

var ParseNanos =v1.ParseNanos

var ParseRFC3339Nanos =v1.ParseRFC3339Nanos

var Plus =v1.Plus

var Print =v1.Print

var Product =v1.Product

var ProvidersAWSSignReqObj =v1.ProvidersAWSSignReqObj

var RandIntn =v1.RandIntn

var ReachableBuiltin =v1.ReachableBuiltin

var ReachablePathsBuiltin =v1.ReachablePathsBuiltin

var RegexFind =v1.RegexFind

var RegexFindAllStringSubmatch =v1.RegexFindAllStringSubmatch

var RegexIsValid =v1.RegexIsValid

var RegexMatch =v1.RegexMatch

var RegexMatchDeprecated =v1.RegexMatchDeprecated

var RegexReplace =v1.RegexReplace

var RegexSplit =v1.RegexSplit

var RegexTemplateMatch =v1.RegexTemplateMatch

var RegoMetadataChain =v1.RegoMetadataChain

var RegoMetadataRule =v1.RegoMetadataRule

var RegoParseModule =v1.RegoParseModule

var RegoRootDocument =v1.RegoRootDocument

var RegoV1CompatibleRef =v1.RegoV1CompatibleRef

var Rem =v1.Rem

var RenderTemplate =v1.RenderTemplate

var Replace =v1.Replace

var ReplaceN =v1.ReplaceN

var ReservedVars =v1.ReservedVars

var RootDocumentNames =v1.RootDocumentNames

var RootDocumentRefs =v1.RootDocumentRefs

var Round =v1.Round

var SafetyCheckVisitorParams =v1.SafetyCheckVisitorParams

var SchemaRootDocument =v1.SchemaRootDocument

var SchemaRootRef =v1.SchemaRootRef

var SemVerCompare =v1.SemVerCompare

var SemVerIsValid =v1.SemVerIsValid

var SetDiff =v1.SetDiff

var Sort =v1.Sort

var Split =v1.Split

var Sprintf =v1.Sprintf

var StartsWith =v1.StartsWith

var StringCount =v1.StringCount

var StringReverse =v1.StringReverse

var Substring =v1.Substring

var Sum =v1.Sum

var ToNumber =v1.ToNumber

var Trace =v1.Trace

var Trim =v1.Trim

var TrimLeft =v1.TrimLeft

var TrimPrefix =v1.TrimPrefix

var TrimRight =v1.TrimRight

var TrimSpace =v1.TrimSpace

var TrimSuffix =v1.TrimSuffix

var TypeNameBuiltin =v1.TypeNameBuiltin

var URLQueryDecode =v1.URLQueryDecode

var URLQueryDecodeObject =v1.URLQueryDecodeObject

var URLQueryEncode =v1.URLQueryEncode

var URLQueryEncodeObject =v1.URLQueryEncodeObject

var UUIDParse =v1.UUIDParse

var UUIDRFC4122 =v1.UUIDRFC4122

var Union =v1.Union

var UnitsParse =v1.UnitsParse

var UnitsParseBytes =v1.UnitsParseBytes

var Upper =v1.Upper

var WalkBuiltin =v1.WalkBuiltin

var Weekday =v1.Weekday

var Wildcard =v1.Wildcard

var YAMLIsValid =v1.YAMLIsValid

var YAMLMarshal =v1.YAMLMarshal

var YAMLUnmarshal =v1.YAMLUnmarshal

funcAs¶added inv0.14.0

func As(vValue, xany)error

As converts v into a Go native type referred to by x.

funcBuildAnnotationSet¶added inv0.38.0

func BuildAnnotationSet(modules []*Module) (*AnnotationSet,Errors)

funcCompare¶added inv0.2.0

func Compare(a, bany)int

Compare returns an integer indicating whether two AST values are less than,equal to, or greater than each other.

If a is less than b, the return value is negative. If a is greater than b,the return value is positive. If a is equal to b, the return value is zero.

Different types are never equal to each other. For comparison purposes, typesare sorted as follows:

nil < Null < Boolean < Number < String < Var < Ref < Array < Object < Set <ArrayComprehension < ObjectComprehension < SetComprehension < Expr < SomeDecl< With < Body < Rule < Import < Package < Module.

Arrays and Refs are equal if and only if both a and b have the same lengthand all corresponding elements are equal. If one element is not equal, thereturn value is the same as for the first differing element. If all elementsare equal but a and b have different lengths, the shorter is considered lessthan the other.

Objects are considered equal if and only if both a and b have the same sorted(key, value) pairs and are of the same length. Other comparisons areconsistent but not defined.

Sets are considered equal if and only if the symmetric difference of a and bis empty.Other comparisons are consistent but not defined.

funcContainsClosures¶added inv0.37.0

func ContainsClosures(vany)bool

ContainsClosures returns true if the Value v contains closures.

funcContainsComprehensions¶added inv0.5.8

func ContainsComprehensions(vany)bool

ContainsComprehensions returns true if the Value v contains comprehensions.

funcContainsRefs¶added inv0.5.8

func ContainsRefs(vany)bool

ContainsRefs returns true if the Value v contains refs.

funcCopy¶added inv0.20.5

func Copy(xany)any

Copy returns a deep copy of the AST node x. If x is not an AST node, x is returned unmodified.

funcHasInternedIntNumberTerm¶added inv1.0.0

func HasInternedIntNumberTerm(iint)bool

funcIsComprehension¶added inv0.5.11

func IsComprehension(xValue)bool

IsComprehension returns true if the supplied value is a comprehension.

funcIsConstant¶added inv0.4.9

func IsConstant(vValue)bool

IsConstant returns true if the AST value is constant.

funcIsError¶added inv0.4.0

func IsError(codestring, errerror)bool

IsError returns true if err is an AST error with code.

funcIsFutureKeyword¶added inv0.64.0

func IsFutureKeyword(sstring)bool

funcIsInKeywords¶added inv0.69.0

func IsInKeywords(sstring, keywords []string)bool

funcIsKeyword¶added inv0.2.2

func IsKeyword(sstring)bool

IsKeyword returns true if s is a language keyword.

funcIsKeywordInRegoVersion¶added inv0.67.0

func IsKeywordInRegoVersion(sstring, regoVersionRegoVersion)bool

IsKeywordInRegoVersion returns true if s is a language keyword.

funcIsScalar¶added inv0.2.0

func IsScalar(vValue)bool

IsScalar returns true if the AST value is a scalar.

funcIsUnknownValueErr¶added inv0.9.0

func IsUnknownValueErr(errerror)bool

IsUnknownValueErr returns true if the err is an UnknownValueErr.

funcIsValidImportPath¶added inv0.3.0

func IsValidImportPath(vValue) (errerror)

IsValidImportPath returns an error indicating if the import path is invalid.If the import path is valid, err is nil.

funcIsVarCompatibleString¶added inv0.58.0

func IsVarCompatibleString(sstring)bool

funcJSON¶added inv0.4.9

func JSON(vValue) (any,error)

JSON returns the JSON representation of v. The value must not contain anyrefs or terms that require evaluation (e.g., vars, comprehensions, etc.)

funcJSONWithOpt¶added inv0.27.1

func JSONWithOpt(vValue, optJSONOpt) (any,error)

JSONWithOpt returns the JSON representation of v. The value must not contain anyrefs or terms that require evaluation (e.g., vars, comprehensions, etc.)

funcKeywordsForRegoVersion¶added inv0.69.0

func KeywordsForRegoVersion(vRegoVersion) []string

funcLoadCapabilitiesVersions¶added inv0.40.0

func LoadCapabilitiesVersions() ([]string,error)

LoadCapabilitiesVersions loads all capabilities versions

funcMustJSON¶added inv0.25.0

func MustJSON(vValue)any

MustJSON returns the JSON representation of v. The value must not contain anyrefs or terms that require evaluation (e.g., vars, comprehensions, etc.) Ifthe conversion fails, this function will panic. This function is mostly fortest purposes.

funcParseStatements¶

func ParseStatements(filename, inputstring) ([]Statement, []*Comment,error)

ParseStatements is deprecated. Use ParseStatementWithOpts instead.

funcParseStatementsWithOpts¶added inv0.28.0

func ParseStatementsWithOpts(filename, inputstring, poptsParserOptions) ([]Statement, []*Comment,error)

ParseStatementsWithOpts returns a slice of parsed statements. This is thedefault return value from the parser.

funcPretty¶added inv0.7.0

func Pretty(wio.Writer, xany)

Pretty writes a pretty representation of the AST rooted at x to w.

This is function is intended for debug purposes when inspecting ASTs.

funcRegisterBuiltin¶

func RegisterBuiltin(b *Builtin)

RegisterBuiltin adds a new built-in function to the registry.

funcTransform¶added inv0.2.0

func Transform(tTransformer, xany) (any,error)

Transform iterates the AST and calls the Transform function on theTransformer t for x before recursing.

funcTransformComprehensions¶added inv0.5.8

func TransformComprehensions(xany, f func(any) (Value,error)) (any,error)

TransformComprehensions calls the functio nf on all comprehensions under x.

funcTransformRefs¶added inv0.2.0

func TransformRefs(xany, f func(Ref) (Value,error)) (any,error)

TransformRefs calls the function f on all references under x.

funcTransformVars¶added inv0.7.0

func TransformVars(xany, f func(Var) (Value,error)) (any,error)

TransformVars calls the function f on all vars under x.

funcTypeName¶added inv0.3.0

func TypeName(xany)string

TypeName returns a human readable name for the AST element type.

funcValueToInterface¶added inv0.4.9

func ValueToInterface(vValue, resolverResolver) (any,error)

ValueToInterface returns the Go representation of an AST value. The ASTvalue should not contain any values that require evaluation (e.g., vars,comprehensions, etc.)

funcWalkBodies¶added inv0.2.0

func WalkBodies(xany, f func(Body)bool)

WalkBodies calls the function f on all bodies under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkClosures¶

func WalkClosures(xany, f func(any)bool)

WalkClosures calls the function f on all closures under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkExprs¶added inv0.4.9

func WalkExprs(xany, f func(*Expr)bool)

WalkExprs calls the function f on all expressions under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkNodes¶added inv0.9.2

func WalkNodes(xany, f func(Node)bool)

WalkNodes calls the function f on all nodes under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkRefs¶

func WalkRefs(xany, f func(Ref)bool)

WalkRefs calls the function f on all references under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkRules¶added inv0.4.10

func WalkRules(xany, f func(*Rule)bool)

WalkRules calls the function f on all rules under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkTerms¶added inv0.7.0

func WalkTerms(xany, f func(*Term)bool)

WalkTerms calls the function f on all terms under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkVars¶added inv0.2.1

func WalkVars(xany, f func(Var)bool)

WalkVars calls the function f on all vars under x. If the function freturns true, AST nodes under the last node will not be visited.

funcWalkWiths¶added inv0.4.1

func WalkWiths(xany, f func(*With)bool)

WalkWiths calls the function f on all with modifiers under x. If the function freturns true, AST nodes under the last node will not be visited.

typeAnnotationSet¶added inv0.38.0

type AnnotationSet =v1.AnnotationSet

typeAnnotations¶added inv0.28.0

type Annotations =v1.Annotations

Annotations represents metadata attached to other AST nodes such as rules.

typeAnnotationsRef¶added inv0.38.0

type AnnotationsRef =v1.AnnotationsRef

func NewAnnotationsRef(a *Annotations) *AnnotationsRef

typeAnnotationsRefSet¶added inv0.49.0

type AnnotationsRefSet =v1.AnnotationsRefSet

typeArgs¶added inv0.5.0

type Args =v1.Args

Args represents zero or more arguments to a rule.

typeArray¶

type Array =v1.Array

Array represents an array as defined by the language. Arrays are similar to thesame types as defined by JSON with the exception that they can contain Varsand References.

func NewArray(a ...*Term) *Array

typeArrayComprehension¶

type ArrayComprehension =v1.ArrayComprehension

ArrayComprehension represents an array comprehension as defined in the language.

typeAuthorAnnotation¶added inv0.38.0

type AuthorAnnotation =v1.AuthorAnnotation

typeBeforeAfterVisitor¶added inv0.17.0

type BeforeAfterVisitor =v1.BeforeAfterVisitor

BeforeAfterVisitor provides a utility to walk over AST nodes usingclosures. If the before closure returns true, the visitor will notwalk over AST nodes under x. The after closure is invoked alwaysafter visiting a node.

func NewBeforeAfterVisitor(before func(xany)bool, after func(xany)) *BeforeAfterVisitor

typeBody¶

type Body =v1.Body

Body represents one or more expressions contained inside a rule or userfunction.

func MustParseBody(inputstring)Body

func MustParseBodyWithOpts(inputstring, optsParserOptions)Body

func NewBody(exprs ...*Expr)Body

func ParseBody(inputstring) (Body,error)

func ParseBodyWithOpts(inputstring, poptsParserOptions) (Body,error)

typeBoolean¶

type Boolean =v1.Boolean

Boolean represents a boolean value defined by JSON.

typeBuiltin¶

type Builtin =v1.Builtin

Builtin represents a built-in function supported by OPA. Every built-infunction is uniquely identified by a name.

typeCall¶added inv0.7.0

type Call =v1.Call

Call represents as function call in the language.

typeCapabilities¶added inv0.23.0

type Capabilities =v1.Capabilities

Capabilities defines a structure containing data that describes the capabilitiesor features supported by a particular version of OPA.

func CapabilitiesForThisVersion() *Capabilities

func LoadCapabilitiesFile(filestring) (*Capabilities,error)

func LoadCapabilitiesJSON(rio.Reader) (*Capabilities,error)

func LoadCapabilitiesVersion(versionstring) (*Capabilities,error)

typeComment¶added inv0.4.0

type Comment =v1.Comment

Comment contains the raw text from the comment in the definition.

func NewComment(text []byte) *Comment

typeCompileOpts¶added inv0.34.0

type CompileOpts =v1.CompileOpts

CompileOpts defines a set of options for the compiler.

typeCompiler¶

type Compiler =v1.Compiler

Compiler contains the state of a compilation process.

func CompileModules(modules map[string]string) (*Compiler,error)

func CompileModulesWithOpt(modules map[string]string, optsCompileOpts) (*Compiler,error)

func MustCompileModules(modules map[string]string) *Compiler

func MustCompileModulesWithOpts(modules map[string]string, optsCompileOpts) *Compiler

func NewCompiler() *Compiler

typeCompilerEvalMode¶added inv0.58.0

type CompilerEvalMode =v1.CompilerEvalMode

CompilerEvalMode allows toggling certain stages that are onlyneeded for certain modes, Concretely, only "topdown" mode willhave the compiler build comprehension and rule indices.

typeCompilerStage¶added inv0.10.6

type CompilerStage =v1.CompilerStage

CompilerStage defines the interface for stages in the compiler.

typeCompilerStageDefinition¶added inv0.11.0

type CompilerStageDefinition =v1.CompilerStageDefinition

CompilerStageDefinition defines a compiler stage

typeComprehensionIndex¶added inv0.20.0

type ComprehensionIndex =v1.ComprehensionIndex

ComprehensionIndex specifies how the comprehension term can be indexed. The keystell the evaluator what variables to use for indexing. In the future, the indexcould be expanded with more information that would allow the evaluator to indexa larger fragment of comprehensions (e.g., by closing over variables in the outerquery.)

typeDocKind¶

type DocKind =v1.DocKind

DocKind represents the collection of document types that can be produced by rules.

typeError¶added inv0.2.0

type Error =v1.Error

Error represents a single error caught during parsing, compiling, etc.

func NewError(codestring, loc *Location, fstring, a ...any) *Error

typeErrorDetails¶added inv0.4.9

type ErrorDetails =v1.ErrorDetails

ErrorDetails defines the interface for detailed error messages.

typeErrors¶added inv0.2.0

type Errors =v1.Errors

Errors represents a series of errors encountered during parsing, compiling,etc.

func CheckPathConflicts(c *Compiler, exists func([]string) (bool,error))Errors

typeEvery¶added inv0.37.0

type Every =v1.Every

typeExpr¶

type Expr =v1.Expr

Expr represents a single expression contained inside the body of a rule.

func MustParseExpr(inputstring) *Expr

func NewBuiltinExpr(terms ...*Term) *Expr

func NewExpr(termsany) *Expr

func ParseExpr(inputstring) (*Expr,error)

typeFlatAnnotationsRefSet¶added inv0.49.0

type FlatAnnotationsRefSet =v1.FlatAnnotationsRefSet

typeGenericTransformer¶added inv0.2.0

type GenericTransformer =v1.GenericTransformer

GenericTransformer implements the Transformer interface to provide a utilityto transform AST nodes using a closure.

func NewGenericTransformer(f func(xany) (any,error)) *GenericTransformer

typeGenericVisitor¶

type GenericVisitor =v1.GenericVisitor

GenericVisitor provides a utility to walk over AST nodes using aclosure. If the closure returns true, the visitor will not walkover AST nodes under x.

func NewGenericVisitor(f func(xany)bool) *GenericVisitor

typeGraph¶added inv0.5.0

type Graph =v1.Graph

Graph represents the graph of dependencies between rules.

func NewGraph(modules map[string]*Module, list func(Ref) []*Rule) *Graph

typeGraphTraversal¶added inv0.12.0

type GraphTraversal =v1.GraphTraversal

GraphTraversal is a Traversal that understands the dependency graph

func NewGraphTraversal(graph *Graph) *GraphTraversal

typeHead¶added inv0.2.0

type Head =v1.Head

Head represents the head of a rule.

func NewHead(nameVar, args ...*Term) *Head

func RefHead(refRef, args ...*Term) *Head

func VarHead(nameVar, location *Location, jsonOpts *astJSON.Options) *Head

typeImport¶

type Import =v1.Import

Import represents a dependency on a document outside of the policynamespace. Imports are optional.

func MustParseImports(inputstring) []*Import

func ParseImports(inputstring) ([]*Import,error)

typeIndexResult¶added inv0.4.10

type IndexResult =v1.IndexResult

IndexResult contains the result of an index lookup.

func NewIndexResult(kindRuleKind) *IndexResult

typeJSONOpt¶added inv0.27.1

type JSONOpt =v1.JSONOpt

JSONOpt defines parameters for AST to JSON conversion.

typeLocation¶

type Location =v1.Location

Location records a position in source code.

func NewLocation(text []byte, filestring, rowint, colint) *Location

typeModule¶

type Module =v1.Module

Module represents a collection of policies (defined by rules)within a namespace (defined by the package) and optionaldependencies on external documents (defined by imports).

func MustParseModule(inputstring) *Module

func MustParseModuleWithOpts(inputstring, optsParserOptions) *Module

func ParseModule(filename, inputstring) (*Module,error)

func ParseModuleWithOpts(filename, inputstring, poptsParserOptions) (*Module,error)

typeModuleLoader¶added inv0.3.0

type ModuleLoader =v1.ModuleLoader

ModuleLoader defines the interface that callers can implement to enable lazyloading of modules during compilation.

typeModuleTreeNode¶

type ModuleTreeNode =v1.ModuleTreeNode

ModuleTreeNode represents a node in the module tree. The moduletree is keyed by the package path.

typeNode¶added inv0.9.2

type Node =v1.Node

Node represents a node in an AST. Nodes may be statements in a policy moduleor elements of an ad-hoc query, expression, etc.

typeNull¶

type Null =v1.Null

Null represents the null value defined by JSON.

typeNumber¶

type Number =v1.Number

Number represents a numeric value as defined by JSON.

typeObject¶

type Object =v1.Object

Object represents an object as defined by the language.

func LazyObject(blob map[string]any)Object

func NewObject(t ...[2]*Term)Object

typeObjectComprehension¶added inv0.5.2

type ObjectComprehension =v1.ObjectComprehension

ObjectComprehension represents an object comprehension as defined in the language.

typeObjectKeysIterator¶added inv0.43.0

type ObjectKeysIterator =v1.ObjectKeysIterator

NOTE(philipc): The only way to get an ObjectKeyIterator should befrom an Object. This ensures that the iterator can have implementation-specific details internally, with no contracts except to the verylimited interface.

typePackage¶

type Package =v1.Package

Package represents the namespace of the documents producedby rules inside the module.

func MustParsePackage(inputstring) *Package

func ParsePackage(inputstring) (*Package,error)

typeParser¶added inv0.19.0

type Parser =v1.Parser

Parser is used to parse Rego statements.

func NewParser() *Parser

typeParserErrorDetail¶added inv0.15.0

type ParserErrorDetail =v1.ParserErrorDetail

ParserErrorDetail holds additional details for parser errors.

typeParserOptions¶added inv0.28.0

type ParserOptions =v1.ParserOptions

ParserOptions defines the options for parsing Rego statements.

typeQueryCompiler¶added inv0.2.2

type QueryCompiler =v1.QueryCompiler

QueryCompiler defines the interface for compiling ad-hoc queries.

typeQueryCompilerStage¶added inv0.7.0

type QueryCompilerStage =v1.QueryCompilerStage

QueryCompilerStage defines the interface for stages in the query compiler.

typeQueryCompilerStageDefinition¶added inv0.11.0

type QueryCompilerStageDefinition =v1.QueryCompilerStageDefinition

QueryCompilerStageDefinition defines a QueryCompiler stage

typeQueryContext¶added inv0.2.2

type QueryContext =v1.QueryContext

QueryContext contains contextual information for running an ad-hoc query.

Ad-hoc queries can be run in the context of a package and imports may beincluded to provide concise access to data.

func NewQueryContext() *QueryContext

typeQueryIterator¶

type QueryIterator =v1.QueryIterator

QueryIterator defines the interface for querying AST documents with references.

typeRef¶

type Ref =v1.Ref

Ref represents a reference as defined by the language.

func EmptyRef()Ref

func MustParseRef(inputstring)Ref

func ParseRef(inputstring) (Ref,error)

func PtrRef(head *Term, sstring) (Ref,error)

typeRefErrInvalidDetail¶added inv0.5.2

type RefErrInvalidDetail =v1.RefErrInvalidDetail

RefErrInvalidDetail describes an undefined reference error where the referencedvalue does not support the reference operand (e.g., missing object key,invalid key type, etc.)

typeRefErrUnsupportedDetail¶added inv0.5.2

type RefErrUnsupportedDetail =v1.RefErrUnsupportedDetail

RefErrUnsupportedDetail describes an undefined reference error where thereferenced value does not support dereferencing (e.g., scalars).

typeRegoVersion¶added inv0.60.0

type RegoVersion =v1.RegoVersion

RegoVersion defines the Rego syntax requirements for a module.

func RegoVersionFromInt(iint)RegoVersion

typeRelatedResourceAnnotation¶added inv0.38.0

type RelatedResourceAnnotation =v1.RelatedResourceAnnotation

typeResolver¶added inv0.4.9

type Resolver =v1.Resolver

Resolver defines the interface for resolving references to native Go values.

typeRule¶

type Rule =v1.Rule

Rule represents a rule as defined in the language. Rules define thecontent of documents that represent policy decisions.

func MustParseRule(inputstring) *Rule

func MustParseRuleWithOpts(inputstring, optsParserOptions) *Rule

func ParseCompleteDocRuleFromAssignmentExpr(module *Module, lhs, rhs *Term) (*Rule,error)

func ParseCompleteDocRuleFromEqExpr(module *Module, lhs, rhs *Term) (*Rule,error)

func ParseCompleteDocRuleWithDotsFromTerm(module *Module, term *Term) (*Rule,error)

func ParsePartialObjectDocRuleFromEqExpr(module *Module, lhs, rhs *Term) (*Rule,error)

func ParsePartialSetDocRuleFromTerm(module *Module, term *Term) (*Rule,error)

func ParseRule(inputstring) (*Rule,error)

func ParseRuleFromBody(module *Module, bodyBody) (*Rule,error)

func ParseRuleFromCallEqExpr(module *Module, lhs, rhs *Term) (*Rule,error)

func ParseRuleFromCallExpr(module *Module, terms []*Term) (*Rule,error)

func ParseRuleFromExpr(module *Module, expr *Expr) (*Rule,error)

func ParseRuleWithOpts(inputstring, optsParserOptions) (*Rule,error)

typeRuleIndex¶added inv0.4.9

type RuleIndexv1.RuleIndex

RuleIndex defines the interface for rule indices.

typeRuleKind¶added inv0.46.0

type RuleKind =v1.RuleKind

typeRuleSet¶added inv0.4.9

type RuleSet =v1.RuleSet

RuleSet represents a collection of rules that produce a virtual document.

func NewRuleSet(rules ...*Rule)RuleSet

typeRulesOptions¶added inv0.34.0

type RulesOptions =v1.RulesOptions

RulesOptions defines the options for retrieving rules by Ref from thecompiler.

typeSchemaAnnotation¶added inv0.28.0

type SchemaAnnotation =v1.SchemaAnnotation

SchemaAnnotation contains a schema declaration for the document identified by the path.

typeSchemaSet¶added inv0.27.0

type SchemaSet =v1.SchemaSet

SchemaSet holds a map from a path to a schema.

func NewSchemaSet() *SchemaSet

typeSet¶added inv0.2.0

type Set =v1.Set

Set represents a set as defined by the language.

func NewSet(t ...*Term)Set

typeSetComprehension¶added inv0.5.2

type SetComprehension =v1.SetComprehension

SetComprehension represents a set comprehension as defined in the language.

typeSomeDecl¶added inv0.11.0

type SomeDecl =v1.SomeDecl

SomeDecl represents a variable declaration statement. The symbols are variables.

typeStatement¶

type Statement =v1.Statement

Statement represents a single statement in a policy module.

func MustParseStatement(inputstring)Statement

func MustParseStatementWithOpts(inputstring, poptsParserOptions)Statement

func MustParseStatements(inputstring) []Statement

func ParseStatement(inputstring) (Statement,error)

func ParseStatementWithOpts(inputstring, poptsParserOptions) (Statement,error)

typeString¶

type String =v1.String

String represents a string value as defined by JSON.

typeTerm¶

type Term =v1.Term

Term is an argument to a function.

func ArrayComprehensionTerm(term *Term, bodyBody) *Term

func ArrayTerm(a ...*Term) *Term

func BooleanTerm(bbool) *Term

func CallTerm(terms ...*Term) *Term

func FloatNumberTerm(ffloat64) *Term

func IntNumberTerm(iint) *Term

func InternedBooleanTerm(bbool) *Term

func InternedIntNumberTerm(iint) *Term

func Item(key, value *Term) [2]*Term

func MustParseTerm(inputstring) *Term

func NewTerm(vValue) *Term

func NullTerm() *Term

func NumberTerm(njson.Number) *Term

func ObjectComprehensionTerm(key, value *Term, bodyBody) *Term

func ObjectTerm(o ...[2]*Term) *Term

func ParseTerm(inputstring) (*Term,error)

func RefTerm(r ...*Term) *Term

func SetComprehensionTerm(term *Term, bodyBody) *Term

func SetTerm(t ...*Term) *Term

func StringTerm(sstring) *Term

func UIntNumberTerm(uuint64) *Term

func VarTerm(vstring) *Term

typeTransformer¶added inv0.2.0

type Transformer =v1.Transformer

Transformer defines the interface for transforming AST elements. If thetransformer returns nil and does not indicate an error, the AST element willbe set to nil and no transformations will be applied to children of theelement.

typeTreeNode¶added inv0.5.0

type TreeNode =v1.TreeNode

TreeNode represents a node in the rule tree. The rule tree is keyed byrule path.

func NewRuleTree(mtree *ModuleTreeNode) *TreeNode

typeTypeEnv¶added inv0.4.9

type TypeEnv =v1.TypeEnv

TypeEnv contains type info for static analysis such as type checking.

typeUnificationErrDetail¶added inv0.4.9

type UnificationErrDetail =v1.UnificationErrDetail

UnificationErrDetail describes a type mismatch error when two values areunified (e.g., x = [1,2,y]).

typeUnknownValueErr¶added inv0.9.0

type UnknownValueErr =v1.UnknownValueErr

UnknownValueErr indicates a ValueResolver was unable to resolve a referencebecause the reference refers to an unknown value.

typeValue¶

type Value =v1.Value

Value declares the common interface for all Term values. Every kind of Term valuein the language is represented as a type that implements this interface:

- Null, Boolean, Number, String- Object, Array, Set- Variables, References- Array, Set, and Object Comprehensions- Calls

func InterfaceToValue(xany) (Value,error)

func MustInterfaceToValue(xany)Value

func ValueFromReader(rio.Reader) (Value,error)

typeValueMap¶added inv0.2.0

type ValueMap =v1.ValueMap

ValueMap represents a key/value map between AST term values. Any type of termcan be used as a key in the map.

func NewValueMap() *ValueMap

typeValueResolver¶added inv0.4.9

type ValueResolver =v1.ValueResolver

ValueResolver defines the interface for resolving references to AST values.

typeVar¶

type Var =v1.Var

Var represents a variable as defined by the language.

typeVarSet¶

type VarSet =v1.VarSet

VarSet represents a set of variables.

func NewVarSet(vs ...Var)VarSet

func OutputVarsFromBody(c *Compiler, bodyBody, safeVarSet)VarSet

func OutputVarsFromExpr(c *Compiler, expr *Expr, safeVarSet)VarSet

func Unify(safeVarSet, a *Term, b *Term)VarSet

typeVarVisitor¶added inv0.3.0

type VarVisitor =v1.VarVisitor

VarVisitor walks AST nodes under a given node and collects all encounteredvariables. The collected variables can be controlled by specifyingVarVisitorParams when creating the visitor.

func NewVarVisitor() *VarVisitor

typeVarVisitorParams¶added inv0.3.0

type VarVisitorParams =v1.VarVisitorParams

VarVisitorParams contains settings for a VarVisitor.

typeVersionIndex¶added inv0.59.0

type VersionIndex =v1.VersionIndex

VersonIndex contains an index from built-in function name, language feature,and future rego keyword to version number. During the build, this is used tocreate an index of the minimum version required for the built-in/feature/kw.

typeWasmABIVersion¶added inv0.27.0

type WasmABIVersion =v1.WasmABIVersion

WasmABIVersion captures the Wasm ABI version. Its `Minor` version is indicatingbackwards-compatible changes.

typeWith¶added inv0.4.1

type With =v1.With

With represents a modifier on an expression.