values

Documentation

Overview

Package values declares the flux data types and implements them.

Index

• Variables
• func AssignableTo(V, T semantic.Type) bool
• func BuildExternAssignments(node semantic.Node, scope Scope) semantic.Node
• func CheckKind(got, exp semantic.Nature)
• func FormattedScope(scope Scope) fmt.Formatter
• func NewFunction(name string, typ semantic.PolyType, ...) *function
• func NewObject() *object
• func NewObjectWithBacking(size int) *object
• func NewObjectWithValues(vals map[string]Value) *object
• func UnexpectedKind(got, exp semantic.Nature) error
• type Array
  • func NewArray(elementType semantic.Type) Array
  • func NewArrayWithBacking(elementType semantic.Type, elements []Value) Array
• type BinaryFuncSignature
• type BinaryFunction
  • func LookupBinaryFunction(sig BinaryFuncSignature) (BinaryFunction, error)
• type Duration
  • func ParseDuration(s string) (Duration, error)
  • func (d Duration) Duration() time.Duration
  • func (d Duration) String() string
• type Function
• type Object
• type Package
• type Scope
  • func NewNestedScope(parent Scope, obj Object) Scope
  • func NewScope() Scope
• type Time
  • func ConvertTime(t time.Time) Time
  • func ParseTime(s string) (Time, error)
  • func (t Time) Add(d Duration) Time
  • func (t Time) Remainder(d Duration) (r Duration)
  • func (t Time) Round(d Duration) Time
  • func (t Time) String() string
  • func (t Time) Time() time.Time
  • func (t Time) Truncate(d Duration) Time
• type Typer
• type Value
  • func New(v interface{}) Value
  • func NewBool(v bool) Value
  • func NewBytes(v []byte) Value
  • func NewDuration(v Duration) Value
  • func NewFloat(v float64) Value
  • func NewFromString(t semantic.Type, s string) (Value, error)
  • func NewInt(v int64) Value
  • func NewNull(t semantic.Type) Value
  • func NewRegexp(v *regexp.Regexp) Value
  • func NewString(v string) Value
  • func NewTime(v Time) Value
  • func NewUInt(v uint64) Value
• type ValueStringer

Variables

var (
	// InvalidValue is a non nil value who's type is semantic.Invalid
	InvalidValue = value{/* contains filtered or unexported fields */}

	// Null is an untyped nil value.
	Null = value{/* contains filtered or unexported fields */}
)

Functions

func AssignableTo

func AssignableTo(V, T semantic.Type) bool

AssignableTo returns true if type V is assignable to type T.

func BuildExternAssignments

func BuildExternAssignments(node semantic.Node, scope Scope) semantic.Node

BuildExternAssignments constructs nested semantic.ExternAssignment nodes mirroring the nested structure of the scope.

func CheckKind

func CheckKind(got, exp semantic.Nature)

CheckKind panics if got != exp.

func FormattedScope

func FormattedScope(scope Scope) fmt.Formatter

FormattedScope produces a fmt.Formatter for pretty printing a scope.

func NewFunction

func NewFunction(name string, typ semantic.PolyType, call func(ctx context.Context, args Object) (Value, error), sideEffect bool) *function

NewFunction returns a new function value

func NewObject

func NewObject() *object

func NewObjectWithBacking

func NewObjectWithBacking(size int) *object

func NewObjectWithValues

func NewObjectWithValues(vals map[string]Value) *object

func UnexpectedKind

func UnexpectedKind(got, exp semantic.Nature) error

Types

type Array

type Array interface {
	Value
	Get(i int) Value
	Set(i int, v Value)
	Append(v Value)
	Len() int
	Range(func(i int, v Value))
	Sort(func(i, j Value) bool)
}

Array represents an sequence of elements All elements must be the same type

func NewArray

func NewArray(elementType semantic.Type) Array

func NewArrayWithBacking

func NewArrayWithBacking(elementType semantic.Type, elements []Value) Array

type BinaryFuncSignature

type BinaryFuncSignature struct {
	Operator    ast.OperatorKind
	Left, Right semantic.Nature
}

type BinaryFunction

type BinaryFunction func(l, r Value) (Value, error)

func LookupBinaryFunction

func LookupBinaryFunction(sig BinaryFuncSignature) (BinaryFunction, error)

LookupBinaryFunction returns an appropriate binary function that evaluates two values and returns another value. If the two types are not compatible with the given operation, this returns an error.

type Duration

type Duration int64

func ParseDuration

func ParseDuration(s string) (Duration, error)

func (Duration) Duration

func (d Duration) Duration() time.Duration

func (Duration) String

func (d Duration) String() string

type Function

type Function interface {
	Value
	HasSideEffect() bool
	Call(ctx context.Context, args Object) (Value, error)
}

Function represents a callable type

type Object

type Object interface {
	Value
	Get(name string) (Value, bool)
	Set(name string, v Value)
	Len() int
	Range(func(name string, v Value))
}

type Package

type Package interface {
	Object
	SetOption(name string, v Value)
}

type Scope

type Scope interface {
	// Lookup a name in the scope.
	Lookup(name string) (Value, bool)

	// LocalLookup a name in current scope only.
	LocalLookup(name string) (Value, bool)

	// Set binds a variable in the current scope.
	Set(name string, v Value)
	// SetOption binds a variable in the package option scope.
	// Setting an option must occur on the specific package value.
	// If the package cannot be found no option is set, in which case the boolean return is false.
	// An error is reported if the specified package is not a package value.
	SetOption(pkg, name string, v Value) (bool, error)

	// Nest creates a new scope by nesting the current scope.
	// If the passed in object is not nil, its values will be added to the new nested scope.
	Nest(Object) Scope

	// Pop returns the parent of the current scope.
	Pop() Scope

	// Size is the number of visible names in scope.
	Size() int

	// Range iterates over all variable bindings in scope applying f.
	Range(f func(k string, v Value))

	// LocalRange iterates over all variable bindings only in the current scope.
	LocalRange(f func(k string, v Value))

	// SetReturn binds the return value of the scope.
	SetReturn(Value)

	// Return reports the bound return value of the scope.
	Return() Value

	// Copy creates a deep copy of the scope, values are not copied.
	// Copy preserves the nesting structure.
	Copy() Scope
}

func NewNestedScope

func NewNestedScope(parent Scope, obj Object) Scope

NewNestedScope creates a new scope with bindings from obj and a parent.

func NewScope

func NewScope() Scope

NewScope creates a new empty scope with no parent.

type Time

type Time int64

func ConvertTime

func ConvertTime(t time.Time) Time

func ParseTime

func ParseTime(s string) (Time, error)

func (Time) Add

func (t Time) Add(d Duration) Time

func (Time) Remainder

func (t Time) Remainder(d Duration) (r Duration)

remainder divides t by d and returns the remainder.

func (Time) Round

func (t Time) Round(d Duration) Time

func (Time) String

func (t Time) String() string

func (Time) Time

func (t Time) Time() time.Time

func (Time) Truncate

func (t Time) Truncate(d Duration) Time

type Typer

type Typer interface {
	Type() semantic.Type
	PolyType() semantic.PolyType
}

type Value

type Value interface {
	Typer
	IsNull() bool
	Str() string
	Bytes() []byte
	Int() int64
	UInt() uint64
	Float() float64
	Bool() bool
	Time() Time
	Duration() Duration
	Regexp() *regexp.Regexp
	Array() Array
	Object() Object
	Function() Function
	Equal(Value) bool
}

func New

func New(v interface{}) Value

New constructs a new Value by inferring the type from the interface. If the interface does not translate to a valid Value type, then InvalidValue is returned.

func NewBool

func NewBool(v bool) Value

func NewBytes

func NewBytes(v []byte) Value

func NewDuration

func NewDuration(v Duration) Value

func NewFloat

func NewFloat(v float64) Value

func NewFromString

func NewFromString(t semantic.Type, s string) (Value, error)

func NewInt

func NewInt(v int64) Value

func NewNull

func NewNull(t semantic.Type) Value

func NewRegexp

func NewRegexp(v *regexp.Regexp) Value

func NewString

func NewString(v string) Value

func NewTime

func NewTime(v Time) Value

func NewUInt

func NewUInt(v uint64) Value

type ValueStringer

type ValueStringer interface {
	String() string
}