Method CompileOptions

cel/library.go:408–588

CompileOptions implements the Library interface method.

()

// CompileOptions implements the Library interface method.
func (lib *optionalLib) CompileOptions() []EnvOption {
	paramTypeK := TypeParamType("K")
	paramTypeV := TypeParamType("V")
	optionalTypeV := OptionalType(paramTypeV)
	listTypeV := ListType(paramTypeV)
	mapTypeKV := MapType(paramTypeK, paramTypeV)
	listOptionalTypeV := ListType(optionalTypeV)

	opts := []EnvOption{
		// Enable the optional syntax in the parser.
		enableOptionalSyntax(),

		// Introduce the optional type.
		Types(types.OptionalType),

		// Configure the optMap and optFlatMap macros.
		Macros(ReceiverMacro(optMapMacro, 2, optMap,
			MacroDocs(`perform computation on the value if present and return the result as an optional`),
			MacroExamples(
				common.MultilineDescription(
					`// sub with the prefix 'dev.cel' or optional.none()`,
					`request.auth.tokens.?sub.optMap(id, 'dev.cel.' + id)`),
				`optional.none().optMap(i, i * 2) // optional.none()`))),

		// Global and member functions for working with optional values.
		Function(optionalOfFunc,
			FunctionDocs(`create a new optional_type(T) with a value where any value is considered valid`),
			Overload("optional_of", []*Type{paramTypeV}, optionalTypeV,
				OverloadExamples(`optional.of(1) // optional(1)`),
				UnaryBinding(func(value ref.Val) ref.Val {
					return types.OptionalOf(value)
				}))),
		Function(optionalOfNonZeroValueFunc,
			FunctionDocs(`create a new optional_type(T) with a value, if the value is not a zero or empty value`),
			Overload("optional_ofNonZeroValue", []*Type{paramTypeV}, optionalTypeV,
				OverloadExamples(
					`optional.ofNonZeroValue(null) // optional.none()`,
					`optional.ofNonZeroValue("") // optional.none()`,
					`optional.ofNonZeroValue("hello") // optional.of('hello')`),
				UnaryBinding(func(value ref.Val) ref.Val {
					v, isZeroer := value.(traits.Zeroer)
					if !isZeroer || !v.IsZeroValue() {
						return types.OptionalOf(value)
					}
					return types.OptionalNone
				}))),
		Function(optionalNoneFunc,
			FunctionDocs(`singleton value representing an optional without a value`),
			Overload("optional_none", []*Type{}, optionalTypeV,
				OverloadExamples(`optional.none()`),
				FunctionBinding(func(values ...ref.Val) ref.Val {
					return types.OptionalNone
				}))),
		Function(valueFunc,
			FunctionDocs(`obtain the value contained by the optional, error if optional.none()`),
			MemberOverload("optional_value", []*Type{optionalTypeV}, paramTypeV,
				OverloadExamples(
					`optional.of(1).value() // 1`,