Documentation
¶
Overview ¶
Package compile implements bundles compilation and linking.
Index ¶
- Constants
- type Compiler
- func (c *Compiler) Build(ctx context.Context) error
- func (c *Compiler) Debug() []Debug
- func (c *Compiler) WithAsBundle(enabled bool) *Compiler
- func (c *Compiler) WithBundleSigningConfig(config *bundle.SigningConfig) *Compiler
- func (c *Compiler) WithBundleVerificationConfig(config *bundle.VerificationConfig) *Compiler
- func (c *Compiler) WithBundleVerificationKeyID(keyID string) *Compiler
- func (c *Compiler) WithCapabilities(capabilities *ast.Capabilities) *Compiler
- func (c *Compiler) WithEntrypoints(e ...string) *Compiler
- func (c *Compiler) WithFilter(filter loader.Filter) *Compiler
- func (c *Compiler) WithOptimizationLevel(n int) *Compiler
- func (c *Compiler) WithOutput(w io.Writer) *Compiler
- func (c *Compiler) WithPaths(p ...string) *Compiler
- func (c *Compiler) WithRevision(r string) *Compiler
- func (c *Compiler) WithTarget(t string) *Compiler
- type Debug
Constants ¶
const ( // TargetRego is the default target. The source rego is copied (potentially // rewritten for optimization purpsoes) into the bundle. The target supports // base documents. TargetRego = "rego" // TargetWasm is an alternative target that compiles the policy into a wasm // module instead of Rego. The target supports base documents. TargetWasm = "wasm" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Compiler ¶
type Compiler struct {
// contains filtered or unexported fields
}
Compiler implements bundle compilation and linking.
func (*Compiler) Build ¶
Build compiles and links the input files and outputs a bundle to the writer.
func (*Compiler) WithAsBundle ¶
WithAsBundle sets file loading mode on the compiler.
func (*Compiler) WithBundleSigningConfig ¶ added in v0.22.0
func (c *Compiler) WithBundleSigningConfig(config *bundle.SigningConfig) *Compiler
WithBundleSigningConfig sets the key configuration to use to generate a signed bundle
func (*Compiler) WithBundleVerificationConfig ¶ added in v0.22.0
func (c *Compiler) WithBundleVerificationConfig(config *bundle.VerificationConfig) *Compiler
WithBundleVerificationConfig sets the key configuration to use to verify a signed bundle
func (*Compiler) WithBundleVerificationKeyID ¶ added in v0.22.0
WithBundleVerificationKeyID sets the key to use to verify a signed bundle. If provided, the "keyid" claim in the bundle signature, will be set to this value
func (*Compiler) WithCapabilities ¶ added in v0.23.0
func (c *Compiler) WithCapabilities(capabilities *ast.Capabilities) *Compiler
WithCapabilities sets the capabilities to use while checking policies.
func (*Compiler) WithEntrypoints ¶
WithEntrypoints sets the policy entrypoints on the compiler. Entrypoints tell the compiler what rules to expect and where optimizations can be targetted. The wasm target requires at least one entrypoint as does optimization.
func (*Compiler) WithFilter ¶
WithFilter sets the loader filter to use when reading non-bundle input files.
func (*Compiler) WithOptimizationLevel ¶
WithOptimizationLevel sets the optimization level on the compiler. By default optimizations are disabled. Higher levels apply more aggressive optimizations but can take longer.
func (*Compiler) WithOutput ¶
WithOutput sets the output stream to write the bundle to.
func (*Compiler) WithRevision ¶
WithRevision sets the revision to include in the output bundle manifest.
func (*Compiler) WithTarget ¶
WithTarget sets the output target type to use.
Source Files