values

package

v0.7.2 Latest Latest Go to latest Published: Dec 4, 2018 License: MIT Imports: 9 Imported by: 30

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/influxdata/flux

Links

Open Source Insights

Documentation ¶

Overview ¶

Package values declares the flux data types and implements them.

Index ¶

Variables
func CheckKind(got, exp semantic.Nature)
func NewObject() *object
func NewObjectWithValues(values 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
- func NewFunction(name string, typ semantic.Type, call func(args Object) (Value, error), ...) Function
type Object
type Time
- func ConvertTime(t time.Time) Time
- func ParseTime(s string) (Time, error)
- func (t Time) Add(d Duration) Time
- 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 NewDuration(v Duration) Value
- func NewFloat(v float64) Value
- func NewInt(v int64) Value
- func NewRegexp(v *regexp.Regexp) Value
- func NewString(v string) Value
- func NewTime(v Time) Value
- func NewUInt(v uint64) Value

Constants ¶

This section is empty.

Variables ¶

View Source

var InvalidValue = value{/* contains filtered or unexported fields */}

InvalidValue is a non nil value who's type is semantic.Invalid

Functions ¶

func CheckKind ¶

func CheckKind(got, exp semantic.Nature)

CheckKind panics if got != exp.

func NewObject ¶

func NewObject() *object

func NewObjectWithValues ¶

func NewObjectWithValues(values 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.Type
}

type BinaryFunction ¶

type BinaryFunction func(l, r Value) Value

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(args Object) (Value, error)
}

Function represents a callable type

func NewFunction ¶

func NewFunction(name string, typ semantic.Type, call func(args Object) (Value, error), sideEffect bool) Function

NewFunction returns a new function value

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 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) 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
	Str() string
	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.