# Functions
BuiltinErrorList supplies an error slice to store built-in function errors.
Capabilities configures the underlying compiler's capabilities.
CompilePartial defines an option to control whether partial evaluation is run before the query is planned and compiled.
Compiler returns an argument that sets the Rego compiler.
DisableInlining adds a set of paths to exclude from partial evaluation inlining.
DistributedTracingOpts sets the options to be used by distributed tracing.
Dump returns an argument that sets the writer to dump debugging information to.
EnablePrintStatements enables print() calls.
EvalCopyMaps causes the evaluator to copy `map[string]interface{}`s before returning them.
EvalDisableInlining returns an argument that adds a set of paths to exclude from partial evaluation inlining.
EvalEarlyExit will disable 'early exit' optimizations for the evaluation.
EvalInput configures the input for a Prepared Query's evaluation.
EvalInstrument enables or disables instrumenting for a Prepared Query's evaluation.
EvalInterQueryBuiltinCache sets the inter-query cache that built-in functions can utilize during evaluation.
EvalInterQueryBuiltinValueCache sets the inter-query value cache that built-in functions can utilize during evaluation.
EvalMetrics configures the metrics for a Prepared Query's evaluation.
EvalNDBuiltinCache sets the non-deterministic builtin cache that built-in functions can use during evaluation.
EvalParsedInput configures the input for a Prepared Query's evaluation.
EvalParsedUnknowns returns an argument that sets the values to treat as unknown during partial evaluation.
EvalPartialNamespace returns an argument that sets the namespace to use for partial evaluation results.
EvalPrintHook sets the object to use for handling print statement outputs.
EvalQueryTracer configures a tracer for a Prepared Query's evaluation.
EvalResolver sets a Resolver for a specified ref path for this evaluation.
EvalRuleIndexing will disable indexing optimizations for the evaluation.
EvalSeed sets a reader that will seed randomization required by built-in functions.
EvalSortSets causes the evaluator to sort sets before returning them as JSON arrays.
EvalTime sets the wall clock time to use during policy evaluation.
EvalTracer configures a tracer for a Prepared Query's evaluation Deprecated: Use EvalQueryTracer instead.
EvalTransaction configures the Transaction for a Prepared Query's evaluation.
EvalUnknowns returns an argument that sets the values to treat as unknown during partial evaluation.
EvalVirtualCache sets the topdown.VirtualCache to use for evaluation.
Function1 returns an option that adds a built-in function to the Rego object.
Function2 returns an option that adds a built-in function to the Rego object.
Function3 returns an option that adds a built-in function to the Rego object.
Function4 returns an option that adds a built-in function to the Rego object.
FunctionDecl returns an option that adds a custom-built-in function __declaration__.
FunctionDyn returns an option that adds a built-in function to the Rego object.
GenerateJSON sets the AST to JSON converter for the results.
Imports returns an argument that adds a Rego import to the query's context.
Input returns an argument that sets the Rego input document.
Instrument returns an argument that enables instrumentation for diagnosing performance issues.
InterQueryBuiltinCache sets the inter-query cache that built-in functions can utilize during evaluation.
InterQueryBuiltinValueCache sets the inter-query value cache that built-in functions can utilize during evaluation.
IsPartialEvaluationNotEffectiveErr returns true if err is an error returned by this package to indicate that partial evaluation was ineffective.
Load returns an argument that adds a filesystem path to load data and Rego modules from.
LoadBundle returns an argument that adds a filesystem path to load a bundle from.
Metrics returns an argument that sets the metrics collection.
Module returns an argument that adds a Rego module.
NDBuiltinCache sets the non-deterministic builtins cache.
New returns a new Rego object.
NewHaltError wraps an error such that the evaluation process will stop when it occurs.
Package returns an argument that sets the Rego package on the query's context.
ParsedBundle returns an argument that adds a bundle to be loaded.
ParsedImports returns an argument that adds Rego imports to the query's context.
ParsedInput returns an argument that sets the Rego input document.
ParsedModule returns an argument that adds a parsed Rego module.
ParsedPackage returns an argument that sets the Rego package on the query's context.
ParsedQuery returns an argument that sets the Rego query.
ParsedUnknowns returns an argument that sets the values to treat as unknown during partial evaluation.
PartialNamespace returns an argument that sets the namespace to use for partial evaluation results.
PrintHook sets the object to use for handling print statement outputs.
PrintTrace is a helper function to write a human-readable version of the trace to the writer w.
PrintTraceWithLocation is a helper function to write a human-readable version of the trace to the writer w.
Query returns an argument that sets the Rego query.
QueryTracer returns an argument that adds a query tracer to r.
RegisterBuiltin1 adds a built-in function globally inside the OPA runtime.
RegisterBuiltin2 adds a built-in function globally inside the OPA runtime.
RegisterBuiltin3 adds a built-in function globally inside the OPA runtime.
RegisterBuiltin4 adds a built-in function globally inside the OPA runtime.
RegisterBuiltinDyn adds a built-in function globally inside the OPA runtime.
Resolver sets a Resolver for a specified ref path.
Runtime returns an argument that sets the runtime data to provide to the evaluation engine.
Schemas sets the schemaSet.
Seed sets a reader that will seed randomization required by built-in functions.
ShallowInlining prevents rules that depend on unknown values from being inlined.
SkipBundleVerification skips verification of a signed bundle.
SkipPartialNamespace disables namespacing of partial evalution results for support rules generated from policy.
Store returns an argument that sets the policy engine's data storage layer.
StoreReadAST returns an argument that sets whether the store should eagerly convert data to AST values.
Strict enables or disables strict-mode in the compiler.
StrictBuiltinErrors tells the evaluator to treat all built-in function errors as fatal errors.
Target sets the runtime to exercise.
Time sets the wall clock time to use during policy evaluation.
Trace returns an argument that enables tracing on r.
Tracer returns an argument that adds a query tracer to r.
Transaction returns an argument that sets the transaction to use for storage layer operations.
Unknowns returns an argument that sets the values to treat as unknown during partial evaluation.
UnsafeBuiltins sets the built-in functions to treat as unsafe and not allow.
WithBuiltinFuncs carries the rego.Function{1,2,3} per-query function definitions to the target plugins.
WithNoInline adds a set of paths to exclude from partial evaluation inlining.
WithPartialEval configures an option for PrepareForEval which will have it perform partial evaluation while preparing the query (similar to rego.Rego#PartialResult).
# Type aliases
BuiltinContext contains additional attributes from the evaluator that built-in functions can use, e.g., the request context.Context, caches, etc.
CompileContext contains options for Compile calls.
CompileOption defines a function to set options on Compile calls.
CompileResult represents the result of compiling a Rego query, zero or more Rego modules, and arbitrary contextual data into an executable.
ErrorDetails interface is satisfied by an error that provides further details.
Errors represents a collection of errors returned when evaluating Rego.
EvalContext defines the set of options allowed to be set at evaluation time.
EvalOption defines a function to set an option on an EvalConfig.
ExpressionValue defines the value of an expression in a Rego query.
Function represents a built-in function that is callable in Rego.
HaltError is an error type to return from a custom function implementation that will abort the evaluation process (analogous to topdown.Halt).
Location defines a position in a Rego query or module.
PartialQueries contains the queries and support modules produced by partial evaluation.
PartialResult represents the result of partial evaluation.
PrepareConfig holds settings to control the behavior of the Prepare call.
PreparedEvalQuery holds the prepared Rego state that has been pre-processed for subsequent evaluations.
PreparedPartialQuery holds the prepared Rego state that has been pre-processed for partial evaluations.
PrepareOption defines a function to set an option to control the behavior of the Prepare call.
Rego constructs a query and can be evaluated to obtain results.
Result defines the output of Rego evaluation.
ResultSet represents a collection of output from Rego evaluation.
Vars represents a collection of variable bindings.