type Config struct {Namestring           `yaml:"name,omitempty"`Descriptionstring           `yaml:"description,omitempty"`Containerstring           `yaml:"container,omitempty"`Imports         []*Import        `yaml:"imports,omitempty"`StdLib          *LibrarySubset   `yaml:"stdlib,omitempty"`Extensions      []*Extension     `yaml:"extensions,omitempty"`ContextVariable *ContextVariable `yaml:"context_variable,omitempty"`Variables       []*Variable      `yaml:"variables,omitempty"`Functions       []*Function      `yaml:"functions,omitempty"`Validators      []*Validator     `yaml:"validators,omitempty"`Features        []*Feature       `yaml:"features,omitempty"`}

funcNewConfig¶

func NewConfig(namestring) *Config

NewConfig creates an instance of a YAML serializable CEL environment configuration.

func (*Config)AddExtensions¶

func (c *Config) AddExtensions(exts ...*Extension) *Config

AddExtensions appends a set of extensions to the config.

func (*Config)AddFeatures¶

func (c *Config) AddFeatures(feats ...*Feature) *Config

AddFeatures appends one or more features to the config.

func (*Config)AddFunctionDecls¶

func (c *Config) AddFunctionDecls(funcs ...*decls.FunctionDecl) *Config

AddFunctionDecls adds one or more functions to the config, converting them to serializable values first.

FunctionDecl inputs are expected to be well-formed.

func (*Config)AddFunctions¶

func (c *Config) AddFunctions(funcs ...*Function) *Config

AddFunctions adds one or more functions to the config.

func (*Config)AddImports¶

func (c *Config) AddImports(imps ...*Import) *Config

AddImports appends a set of imports to the config.

func (*Config)AddValidators¶

func (c *Config) AddValidators(vals ...*Validator) *Config

AddValidators appends one or more validators to the config.

func (*Config)AddVariableDecls¶

func (c *Config) AddVariableDecls(vars ...*decls.VariableDecl) *Config

AddVariableDecls adds one or more variables to the config, converting them to serializable values first.

VariableDecl inputs are expected to be well-formed.

func (*Config)AddVariables¶

func (c *Config) AddVariables(vars ...*Variable) *Config

AddVariables adds one or more vairables to the config.

func (*Config)SetContainer¶

func (c *Config) SetContainer(containerstring) *Config

SetContainer configures the container name for this configuration.

func (*Config)SetContextVariable¶

func (c *Config) SetContextVariable(ctx *ContextVariable) *Config

SetContextVariable configures the ContextVariable for this configuration.

func (*Config)SetStdLib¶

func (c *Config) SetStdLib(subset *LibrarySubset) *Config

SetStdLib configures the LibrarySubset for the standard library.

func (*Config)Validate¶

func (c *Config) Validate()error

Validate validates the whole configuration is well-formed.

type ContextVariable struct {// TypeName represents the fully qualified typename of the context variable.// Currently, only protobuf types are supported.TypeNamestring `yaml:"type_name"`}

funcNewContextVariable¶

func NewContextVariable(typeNamestring) *ContextVariable

NewContextVariable returns a serializable context variable with a specific type name.

func (*ContextVariable)Validate¶

func (ctx *ContextVariable) Validate()error

Validate validates the context-variable configuration is well-formed.

type Extension struct {// Name is either the LibraryName() or some short-hand simple identifier which is understood by the config-handler.Namestring `yaml:"name"`// Version may either be an unsigned long value or the string 'latest'. If empty, the value is treated as '0'.Versionstring `yaml:"version,omitempty"`}

funcNewExtension¶

func NewExtension(namestring, versionuint32) *Extension

NewExtension creates a serializable Extension from a name and version string.

func (*Extension)Validate¶

func (e *Extension) Validate()error

Validate validates the extension configuration is well-formed.

func (*Extension)VersionNumber¶

func (e *Extension) VersionNumber() (uint32,error)

VersionNumber returns the parsed version string, or an error if the version cannot be parsed.

type Feature struct {Namestring `yaml:"name"`Enabledbool   `yaml:"enabled"`}

funcNewFeature¶

func NewFeature(namestring, enabledbool) *Feature

NewFeature creates a new feature flag with a boolean enablement flag.

func (*Feature)Validate¶

func (feat *Feature) Validate()error

Validate validates whether the feature is well-configured.

type Function struct {Namestring      `yaml:"name"`Descriptionstring      `yaml:"description,omitempty"`Overloads   []*Overload `yaml:"overloads,omitempty"`}

funcNewFunction¶

func NewFunction(namestring, overloads ...*Overload) *Function

NewFunction creates a serializable function and overload set.

funcNewFunctionWithDoc¶added inv0.25.0

func NewFunctionWithDoc(name, docstring, overloads ...*Overload) *Function

NewFunctionWithDoc creates a serializable function and overload set.

func (*Function)AsCELFunction¶

func (fn *Function) AsCELFunction(tptypes.Provider) (*decls.FunctionDecl,error)

AsCELFunction converts the serializable form of the Function into CEL environment declaration.

func (*Function)Validate¶

func (fn *Function) Validate()error

Validate validates the function configuration is well-formed.

type Import struct {Namestring `yaml:"name"`}

funcNewImport¶

func NewImport(namestring) *Import

NewImport returns a serializable import value from the qualified type name.

func (*Import)Validate¶

func (imp *Import) Validate()error

Validate validates the import configuration is well-formed.

type LibrarySubset struct {// Disabled indicates whether the library has been disabled, typically only used for// default-enabled libraries like stdlib.Disabledbool `yaml:"disabled,omitempty"`// DisableMacros disables macros for the given library.DisableMacrosbool `yaml:"disable_macros,omitempty"`// IncludeMacros specifies a set of macro function names to include in the subset.IncludeMacros []string `yaml:"include_macros,omitempty"`// ExcludeMacros specifies a set of macro function names to exclude from the subset.// Note: if IncludeMacros is non-empty, then ExcludeFunctions is ignored.ExcludeMacros []string `yaml:"exclude_macros,omitempty"`// IncludeFunctions specifies a set of functions to include in the subset.//// Note: the overloads specified in the subset need only specify their ID.// Note: if IncludeFunctions is non-empty, then ExcludeFunctions is ignored.IncludeFunctions []*Function `yaml:"include_functions,omitempty"`// ExcludeFunctions specifies the set of functions to exclude from the subset.//// Note: the overloads specified in the subset need only specify their ID.ExcludeFunctions []*Function `yaml:"exclude_functions,omitempty"`}

funcNewLibrarySubset¶

func NewLibrarySubset() *LibrarySubset

NewLibrarySubset returns an empty library subsetting config which permits all library features.

func (*LibrarySubset)AddExcludedFunctions¶

func (lib *LibrarySubset) AddExcludedFunctions(funcs ...*Function) *LibrarySubset

AddExcludedFunctions deny-lists one or more functions from the subset.

func (*LibrarySubset)AddExcludedMacros¶

func (lib *LibrarySubset) AddExcludedMacros(macros ...string) *LibrarySubset

AddExcludedMacros deny-lists one or more macros by function name.

func (*LibrarySubset)AddIncludedFunctions¶

func (lib *LibrarySubset) AddIncludedFunctions(funcs ...*Function) *LibrarySubset

AddIncludedFunctions allow-lists one or more functions from the subset.

Note, this option will override any excluded functions.

func (*LibrarySubset)AddIncludedMacros¶

func (lib *LibrarySubset) AddIncludedMacros(macros ...string) *LibrarySubset

AddIncludedMacros allow-lists one or more macros by function name.

Note, this option will override any excluded macros.

func (*LibrarySubset)SetDisableMacros¶

func (lib *LibrarySubset) SetDisableMacros(valuebool) *LibrarySubset

SetDisableMacros disables the macros for the library.

func (*LibrarySubset)SetDisabled¶

func (lib *LibrarySubset) SetDisabled(valuebool) *LibrarySubset

SetDisabled disables or enables the library.

func (*LibrarySubset)SubsetFunction¶

func (lib *LibrarySubset) SubsetFunction(fn *decls.FunctionDecl) (*decls.FunctionDecl,bool)

SubsetFunction produces a function declaration which matches the supported subset, or nilif the function is not supported by the LibrarySubset.

For IncludeFunctions, if the function does not specify a set of overloads to include, thewhole function definition is included. If overloads are set, then a new function whichincludes only the specified overloads is produced.

For ExcludeFunctions, if the function does not specify a set of overloads to exclude, thewhole function definition is excluded. If overloads are set, then a new function whichincludes only the permitted overloads is produced.

func (*LibrarySubset)SubsetMacro¶

func (lib *LibrarySubset) SubsetMacro(macroFunctionstring)bool

SubsetMacro indicates whether the macro function should be included in the library subset.

func (*LibrarySubset)Validate¶

func (lib *LibrarySubset) Validate()error

Validate validates the library configuration is well-formed.

For example, setting both the IncludeMacros and ExcludeMacros together could be confusingand create a broken expectation, likewise for IncludeFunctions and ExcludeFunctions.

type Overload struct {IDstring      `yaml:"id"`Examples []string    `yaml:"examples,omitempty"`Target   *TypeDesc   `yaml:"target,omitempty"`Args     []*TypeDesc `yaml:"args,omitempty"`Return   *TypeDesc   `yaml:"return,omitempty"`}

funcNewMemberOverload¶

func NewMemberOverload(idstring, target *TypeDesc, args []*TypeDesc, ret *TypeDesc, examples ...string) *Overload

NewMemberOverload returns a new serializable representation of a member (receiver) overload.

funcNewOverload¶

func NewOverload(idstring, args []*TypeDesc, ret *TypeDesc, examples ...string) *Overload

NewOverload returns a new serializable representation of a global overload.

func (*Overload)AsFunctionOption¶

func (od *Overload) AsFunctionOption(tptypes.Provider) (decls.FunctionOpt,error)

AsFunctionOption converts the serializable form of the Overload into a function declaration option.

func (*Overload)Validate¶

func (od *Overload) Validate()error

Validate validates the overload configuration is well-formed.

type TypeDesc struct {TypeNamestring      `yaml:"type_name"`Params      []*TypeDesc `yaml:"params,omitempty"`IsTypeParambool        `yaml:"is_type_param,omitempty"`}

funcNewTypeDesc¶

func NewTypeDesc(typeNamestring, params ...*TypeDesc) *TypeDesc

NewTypeDesc describes a simple or complex type with parameters.

funcNewTypeParam¶

func NewTypeParam(paramNamestring) *TypeDesc

NewTypeParam describe a type-param type.

funcSerializeTypeDesc¶added inv0.25.0

func SerializeTypeDesc(t *types.Type) *TypeDesc

SerializeTypeDesc converts a CEL native *types.Type to a serializable TypeDesc.

func (*TypeDesc)AsCELType¶

func (td *TypeDesc) AsCELType(tptypes.Provider) (*types.Type,error)

AsCELType converts the serializable object to a *types.Type value.

func (*TypeDesc)String¶

func (td *TypeDesc) String()string

String implements the strings.Stringer interface method.

func (*TypeDesc)Validate¶

func (td *TypeDesc) Validate()error

Validate validates the type configuration is well-formed.

type Validator struct {Namestring         `yaml:"name"`Config map[string]any `yaml:"config,omitempty"`}

funcNewValidator¶

func NewValidator(namestring) *Validator

NewValidator returns a named Validator instance.

func (*Validator)ConfigValue¶

func (v *Validator) ConfigValue(namestring) (any,bool)

ConfigValue retrieves the value associated with the config key name, if one exists.

func (*Validator)SetConfig¶

func (v *Validator) SetConfig(config map[string]any) *Validator

SetConfig sets the set of map key-value pairs associated with this validator's configuration.

func (*Validator)Validate¶

func (v *Validator) Validate()error

Validate validates the configuration of the validator object.

type Variable struct {Namestring `yaml:"name"`Descriptionstring `yaml:"description,omitempty"`// Type represents the type declaration for the variable.//// Deprecated: use the embedded *TypeDesc fields directly.Type *TypeDesc `yaml:"type,omitempty"`// TypeDesc is an embedded set of fields allowing for the specification of the Variable type.*TypeDesc `yaml:",inline"`}

funcNewVariable¶

func NewVariable(namestring, t *TypeDesc) *Variable

NewVariable returns a serializable variable from a name and type definition

funcNewVariableWithDoc¶added inv0.25.0

func NewVariableWithDoc(namestring, t *TypeDesc, docstring) *Variable

NewVariableWithDoc returns a serializable variable from a name, type definition, and doc string.

func (*Variable)AsCELVariable¶

func (v *Variable) AsCELVariable(tptypes.Provider) (*decls.VariableDecl,error)

AsCELVariable converts the serializable form of the Variable into a CEL environment declaration.

func (*Variable)GetType¶

func (v *Variable) GetType() *TypeDesc

GetType returns the variable type description.

Note, if both the embedded TypeDesc and the field Type are non-nil, the embedded TypeDesc willtake precedence.

func (*Variable)Validate¶

func (v *Variable) Validate()error

Validate validates the variable configuration is well-formed.