package types

import "github.com/open-policy-agent/opa/v1/types"

Package types declares data types for Rego values and helper functions to operate on these types.

Index ¶

• func Arity(x Type) int
• func Compare(a, b Type) int
• func Contains(a, b Type) bool
• func Nil(a Type) bool
• func Sprint(x Type) string
• func Void(x Type) bool
• type Any
• func NewAny(of ...Type) Any
• func (t Any) Contains(other Type) bool
• func (t Any) MarshalJSON() ([]byte, error)
• func (t Any) Merge(other Type) Any
• func (t Any) String() string
• func (t Any) Union(other Any) Any
• type Array
• func NewArray(static []Type, dynamic Type) *Array
• func (t *Array) Dynamic() Type
• func (t *Array) Len() int
• func (t *Array) MarshalJSON() ([]byte, error)
• func (t *Array) Select(pos int) Type
• func (t *Array) String() string
• type Boolean
• func NewBoolean() Boolean
• func (t Boolean) MarshalJSON() ([]byte, error)
• func (t Boolean) String() string
• type DynamicProperty
• func NewDynamicProperty(key, value Type) *DynamicProperty
• func (p *DynamicProperty) MarshalJSON() ([]byte, error)
• func (p *DynamicProperty) String() string
• type FuncArgs
• func (a FuncArgs) Arg(x int) Type
• func (a FuncArgs) String() string
• type Function
• func NewFunction(args []Type, result Type) *Function
• func NewVariadicFunction(args []Type, varargs Type, result Type) *Function
• func (t *Function) Args() []Type
• func (t *Function) Arity() int
• func (t *Function) FuncArgs() FuncArgs
• func (t *Function) MarshalJSON() ([]byte, error)
• func (t *Function) NamedFuncArgs() FuncArgs
• func (t *Function) NamedResult() Type
• func (t *Function) Result() Type
• func (t *Function) String() string
• func (t *Function) Union(other *Function) *Function
• func (t *Function) UnmarshalJSON(bs []byte) error
• type NamedType
• func Named(name string, t Type) *NamedType
• func (n *NamedType) Description(d string) *NamedType
• func (n *NamedType) MarshalJSON() ([]byte, error)
• func (n *NamedType) String() string
• type Null
• func NewNull() Null
• func (t Null) MarshalJSON() ([]byte, error)
• func (Null) String() string
• type Number
• func NewNumber() Number
• func (t Number) MarshalJSON() ([]byte, error)
• func (Number) String() string
• type Object
• func NewObject(static []*StaticProperty, dynamic *DynamicProperty) *Object
• func (t *Object) DynamicProperties() *DynamicProperty
• func (t *Object) DynamicValue() Type
• func (t *Object) Keys() []any
• func (t *Object) MarshalJSON() ([]byte, error)
• func (t *Object) Merge(other Type) *Object
• func (t *Object) Select(name any) Type
• func (t *Object) StaticProperties() []*StaticProperty
• func (t *Object) String() string
• type Set
• func NewSet(of Type) *Set
• func (t *Set) MarshalJSON() ([]byte, error)
• func (t *Set) Of() Type
• func (t *Set) String() string
• type StaticProperty
• func NewStaticProperty(key any, value Type) *StaticProperty
• func (p *StaticProperty) MarshalJSON() ([]byte, error)
• type String
• func NewString() String
• func (t String) MarshalJSON() ([]byte, error)
• func (String) String() string
• type Type
• func Args(x ...Type) []Type
• func Keys(a Type) Type
• func Or(a, b Type) Type
• func Select(a Type, x any) Type
• func TypeOf(x any) Type
• func Unmarshal(bs []byte) (result Type, err error)
• func Values(a Type) Type

Functions ¶

func Arity ¶

func Arity(x Type) int

Arity returns the number of arguments in the function signature or zero if x is not a function. If the type is unknown, this function returns -1.

func Compare ¶

func Compare(a, b Type) int

Compare returns -1, 0, 1 based on comparison between a and b.

func Contains ¶

func Contains(a, b Type) bool

Contains returns true if a is a superset or equal to b.

func Nil ¶

func Nil(a Type) bool

Nil returns true if a's type is unknown.

func Sprint ¶

func Sprint(x Type) string

Sprint returns the string representation of the type.

func Void ¶

func Void(x Type) bool

Void returns true if the function has no return value. This function returns false if x is not a function.

Types ¶

type Any ¶

type Any []Type

Any represents a dynamic type.

func NewAny ¶

func NewAny(of ...Type) Any

NewAny returns a new Any type.

func (Any) Contains ¶

func (t Any) Contains(other Type) bool

Contains returns true if t is a superset of other.

func (Any) MarshalJSON ¶

func (t Any) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (Any) Merge ¶

func (t Any) Merge(other Type) Any

Merge return a new Any type that is the superset of t and other.

func (Any) String ¶

func (t Any) String() string

func (Any) Union ¶

func (t Any) Union(other Any) Any

Union returns a new Any type that is the union of the two Any types. Note(philipc): The two Any slices MUST be sorted before running Union, or else this method will fail to merge the two slices correctly.

type Array ¶

type Array struct {
	// contains filtered or unexported fields
}

Array represents the array type.

func NewArray ¶

func NewArray(static []Type, dynamic Type) *Array

NewArray returns a new Array type.

func (*Array) Dynamic ¶

func (t *Array) Dynamic() Type

Dynamic returns the type of the array's dynamic elements.

func (*Array) Len ¶

func (t *Array) Len() int

Len returns the number of static array elements.

func (*Array) MarshalJSON ¶

func (t *Array) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (*Array) Select ¶

func (t *Array) Select(pos int) Type

Select returns the type of element at the zero-based pos.

func (*Array) String ¶

func (t *Array) String() string

type Boolean ¶

type Boolean struct{}

Boolean represents the boolean type.

func NewBoolean ¶

func NewBoolean() Boolean

NewBoolean returns a new Boolean type.

func (Boolean) MarshalJSON ¶

func (t Boolean) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (Boolean) String ¶

func (t Boolean) String() string

type DynamicProperty ¶

type DynamicProperty struct {
	Key   Type
	Value Type
}

DynamicProperty represents a dynamic object property.

func NewDynamicProperty ¶

func NewDynamicProperty(key, value Type) *DynamicProperty

NewDynamicProperty returns a new DynamicProperty object.

func (*DynamicProperty) MarshalJSON ¶

func (p *DynamicProperty) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of p.

func (*DynamicProperty) String ¶

func (p *DynamicProperty) String() string

type FuncArgs ¶

type FuncArgs struct {
	Args     []Type `json:"args,omitempty"`
	Variadic Type   `json:"variadic,omitempty"`
}

FuncArgs represents the arguments that can be passed to a function.

func (FuncArgs) Arg ¶

func (a FuncArgs) Arg(x int) Type

Arg returns the nth argument's type.

func (FuncArgs) String ¶

func (a FuncArgs) String() string

type Function ¶

type Function struct {
	// contains filtered or unexported fields
}

Function represents a function type.

func NewFunction ¶

func NewFunction(args []Type, result Type) *Function

NewFunction returns a new Function object of the given argument and result types.

func NewVariadicFunction ¶

func NewVariadicFunction(args []Type, varargs Type, result Type) *Function

NewVariadicFunction returns a new Function object. This function sets the variadic bit on the signature. Non-void variadic functions are not currently supported.

func (*Function) Args ¶

func (t *Function) Args() []Type

Args returns the function's arguments as a slice, ignoring variadic arguments. Deprecated: Use FuncArgs instead.

func (*Function) Arity ¶

func (t *Function) Arity() int

Arity returns the number of arguments in the function signature.

func (*Function) FuncArgs ¶

func (t *Function) FuncArgs() FuncArgs

FuncArgs returns the function's arguments.

func (*Function) MarshalJSON ¶

func (t *Function) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (*Function) NamedFuncArgs ¶

func (t *Function) NamedFuncArgs() FuncArgs

NamedFuncArgs returns the function's arguments, with a name and description if available.

func (*Function) NamedResult ¶

func (t *Function) NamedResult() Type

Result returns the function's result type, without stripping name and description.

func (*Function) Result ¶

func (t *Function) Result() Type

Result returns the function's result type.

func (*Function) String ¶

func (t *Function) String() string

func (*Function) Union ¶

func (t *Function) Union(other *Function) *Function

Union returns a new function representing the union of t and other. Functions must have the same arity to be unioned.

func (*Function) UnmarshalJSON ¶

func (t *Function) UnmarshalJSON(bs []byte) error

UnmarshalJSON decodes the JSON serialized function declaration.

type NamedType ¶

type NamedType struct {
	Name, Descr string
	Type        Type
}

NamedType represents a type alias with an arbitrary name and description. This is useful for generating documentation for built-in functions.

func Named ¶

func Named(name string, t Type) *NamedType

Named returns the passed type as a named type. Named types are only valid at the top level of built-in functions. Note that nested named types cause panic.

func (*NamedType) Description ¶

func (n *NamedType) Description(d string) *NamedType

func (*NamedType) MarshalJSON ¶

func (n *NamedType) MarshalJSON() ([]byte, error)

func (*NamedType) String ¶

func (n *NamedType) String() string

type Null ¶

type Null struct{}

Null represents the null type.

func NewNull ¶

func NewNull() Null

NewNull returns a new Null type.

func (Null) MarshalJSON ¶

func (t Null) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (Null) String ¶

func (Null) String() string

type Number ¶

type Number struct{}

Number represents the number type.

func NewNumber ¶

func NewNumber() Number

NewNumber returns a new Number type.

func (Number) MarshalJSON ¶

func (t Number) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (Number) String ¶

func (Number) String() string

type Object ¶

type Object struct {
	// contains filtered or unexported fields
}

Object represents the object type.

func NewObject ¶

func NewObject(static []*StaticProperty, dynamic *DynamicProperty) *Object

NewObject returns a new Object type.

func (*Object) DynamicProperties ¶

func (t *Object) DynamicProperties() *DynamicProperty

DynamicProperties returns the type of the object's dynamic elements.

func (*Object) DynamicValue ¶

func (t *Object) DynamicValue() Type

DynamicValue returns the type of the object's dynamic elements.

func (*Object) Keys ¶

func (t *Object) Keys() []any

Keys returns the keys of the object's static elements.

func (*Object) MarshalJSON ¶

func (t *Object) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (*Object) Merge ¶

func (t *Object) Merge(other Type) *Object

func (*Object) Select ¶

func (t *Object) Select(name any) Type

Select returns the type of the named property.

func (*Object) StaticProperties ¶

func (t *Object) StaticProperties() []*StaticProperty

StaticProperties returns the type of the object's static elements.

func (*Object) String ¶

func (t *Object) String() string

type Set ¶

type Set struct {
	// contains filtered or unexported fields
}

Set represents the set type.

func NewSet ¶

func NewSet(of Type) *Set

NewSet returns a new Set type.

func (*Set) MarshalJSON ¶

func (t *Set) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (*Set) Of ¶

func (t *Set) Of() Type

func (*Set) String ¶

func (t *Set) String() string

type StaticProperty ¶

type StaticProperty struct {
	Key   any
	Value Type
}

StaticProperty represents a static object property.

func NewStaticProperty ¶

func NewStaticProperty(key any, value Type) *StaticProperty

NewStaticProperty returns a new StaticProperty object.

func (*StaticProperty) MarshalJSON ¶

func (p *StaticProperty) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of p.

type String ¶

type String struct{}

String represents the string type.

func NewString ¶

func NewString() String

NewString returns a new String type.

func (String) MarshalJSON ¶

func (t String) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of t.

func (String) String ¶

func (String) String() string

type Type ¶

type Type interface {
	String() string

	json.Marshaler
	// contains filtered or unexported methods
}

Type represents a type of a term in the language.

var (
	SetOfAny Type = NewSet(A)
	SetOfStr Type = NewSet(S)
	SetOfNum Type = NewSet(N)
)

Boxed set types.

var A Type = NewAny()

A represents the superset of all types.

var B Type = NewBoolean()

B represents an instance of the boolean type.

var N Type = NewNumber()

N represents an instance of the number type.

var Nl Type = NewNull()

var S Type = NewString()

S represents an instance of the string type.

func Args ¶

func Args(x ...Type) []Type

Args returns an argument list.

func Keys ¶

func Keys(a Type) Type

Keys returns the type of keys that can be enumerated for a. For arrays, the keys are always number types, for objects the keys are always string types, and for sets the keys are always the type of the set element.

func Or ¶

func Or(a, b Type) Type

Or returns a type that represents the union of a and b. If one type is a superset of the other, the superset is returned unchanged.

func Select ¶

func Select(a Type, x any) Type

Select returns a property or item of a.

func TypeOf ¶

func TypeOf(x any) Type

TypeOf returns the type of the Golang native value.

func Unmarshal ¶

func Unmarshal(bs []byte) (result Type, err error)

Unmarshal deserializes bs and returns the resulting type.

func Values ¶

func Values(a Type) Type

Values returns the type of values that can be enumerated for a.

Source Files ¶

decode.go types.go