core

Documentation

Overview

Package core provides facilities for low-level integration with Starlark.

Index

• func BoolArg(kwargs []starlark.Tuple, keyToFind string) (bool, error)
• func CheckArgNames(kwargs []starlark.Tuple, validKeys map[string]struct{}) error
• func Int64Arg(kwargs []starlark.Tuple, keyToFind string) (int64, error)
• type GoValue
  • func NewGoValue(val interface{}) GoValue
  • func NewGoValueWithOpts(val interface{}, opts GoValueOpts) GoValue
  • func (e GoValue) AsStarlarkValue() starlark.Value
• type GoValueOpts
• type GoValueToStarlarkValueConversion
• type StarlarkFunc
  • func ErrDescWrapper(desc string, wrappedFunc StarlarkFunc) StarlarkFunc
  • func ErrWrapper(wrappedFunc StarlarkFunc) StarlarkFunc
• type StarlarkNoop
  • func (s *StarlarkNoop) Freeze()
  • func (s *StarlarkNoop) Hash() (uint32, error)
  • func (s *StarlarkNoop) String() string
  • func (s *StarlarkNoop) Truth() starlark.Bool
  • func (s *StarlarkNoop) Type() string
• type StarlarkStruct
  • func NewStarlarkStruct(goStringKeyToStarlarkValue *orderedmap.Map) *StarlarkStruct
  • func (s *StarlarkStruct) Attr(name string) (starlark.Value, error)
  • func (s *StarlarkStruct) AttrNames() []string
  • func (s *StarlarkStruct) Freeze()
  • func (s *StarlarkStruct) Get(key starlark.Value) (val starlark.Value, found bool, err error)
  • func (s *StarlarkStruct) Hash() (uint32, error)
  • func (s *StarlarkStruct) Items() (items []starlark.Tuple)
  • func (s *StarlarkStruct) Iterate() starlark.Iterator
  • func (s *StarlarkStruct) Len() int
  • func (s *StarlarkStruct) String() string
  • func (s *StarlarkStruct) Truth() starlark.Bool
  • func (s *StarlarkStruct) Type() string
• type StarlarkStructIterator
  • func (s *StarlarkStructIterator) Done()
  • func (s *StarlarkStructIterator) Next(p *starlark.Value) bool
• type StarlarkValue
  • func NewStarlarkValue(val starlark.Value) StarlarkValue
  • func (e StarlarkValue) AsBool() (bool, error)
  • func (e StarlarkValue) AsFloat64() (float64, error)
  • func (e StarlarkValue) AsGoValue() (interface{}, error)
  • func (e StarlarkValue) AsInt64() (int64, error)
  • func (e StarlarkValue) AsString() (string, error)
• type StarlarkValueToGoValueConversion
• type UnconvertableStarlarkValue

Functions

func BoolArg

func BoolArg(kwargs []starlark.Tuple, keyToFind string) (bool, error)

func CheckArgNames

func CheckArgNames(kwargs []starlark.Tuple, validKeys map[string]struct{}) error

func Int64Arg

func Int64Arg(kwargs []starlark.Tuple, keyToFind string) (int64, error)

Types

type GoValue

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

func NewGoValue

func NewGoValue(val interface{}) GoValue

func NewGoValueWithOpts

func NewGoValueWithOpts(val interface{}, opts GoValueOpts) GoValue

func (GoValue) AsStarlarkValue

func (e GoValue) AsStarlarkValue() starlark.Value

type GoValueOpts

type GoValueOpts struct {
	MapIsStruct bool
	Convert     func(interface{}) (starlark.Value, bool)
}

type GoValueToStarlarkValueConversion

type GoValueToStarlarkValueConversion interface {
	AsStarlarkValue() starlark.Value
}

type StarlarkFunc

type StarlarkFunc func(thread *starlark.Thread, f *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

func ErrDescWrapper

func ErrDescWrapper(desc string, wrappedFunc StarlarkFunc) StarlarkFunc

func ErrWrapper

func ErrWrapper(wrappedFunc StarlarkFunc) StarlarkFunc

type StarlarkNoop

type StarlarkNoop struct{}

func (*StarlarkNoop) Freeze

func (s *StarlarkNoop) Freeze()

func (*StarlarkNoop) Hash

func (s *StarlarkNoop) Hash() (uint32, error)

func (*StarlarkNoop) String

func (s *StarlarkNoop) String() string

func (*StarlarkNoop) Truth

func (s *StarlarkNoop) Truth() starlark.Bool

func (*StarlarkNoop) Type

func (s *StarlarkNoop) Type() string

type StarlarkStruct

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

func NewStarlarkStruct

func NewStarlarkStruct(goStringKeyToStarlarkValue *orderedmap.Map) *StarlarkStruct

func (*StarlarkStruct) Attr

func (s *StarlarkStruct) Attr(name string) (starlark.Value, error)

returns (nil, nil) if attribute not present

func (*StarlarkStruct) AttrNames

func (s *StarlarkStruct) AttrNames() []string

callers must not modify the result.

func (*StarlarkStruct) Freeze

func (s *StarlarkStruct) Freeze()

func (*StarlarkStruct) Get

func (s *StarlarkStruct) Get(key starlark.Value) (val starlark.Value, found bool, err error)

func (*StarlarkStruct) Hash

func (s *StarlarkStruct) Hash() (uint32, error)

func (*StarlarkStruct) Items

func (s *StarlarkStruct) Items() (items []starlark.Tuple)

func (*StarlarkStruct) Iterate

func (s *StarlarkStruct) Iterate() starlark.Iterator

func (*StarlarkStruct) Len

func (s *StarlarkStruct) Len() int

func (*StarlarkStruct) String

func (s *StarlarkStruct) String() string

func (*StarlarkStruct) Truth

func (s *StarlarkStruct) Truth() starlark.Bool

func (*StarlarkStruct) Type

func (s *StarlarkStruct) Type() string

type StarlarkStructIterator

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

func (*StarlarkStructIterator) Done

func (s *StarlarkStructIterator) Done()

func (*StarlarkStructIterator) Next

func (s *StarlarkStructIterator) Next(p *starlark.Value) bool

type StarlarkValue

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

func NewStarlarkValue

func NewStarlarkValue(val starlark.Value) StarlarkValue

func (StarlarkValue) AsBool

func (e StarlarkValue) AsBool() (bool, error)

func (StarlarkValue) AsFloat64

func (e StarlarkValue) AsFloat64() (float64, error)

AsFloat64 converts a Starlark number (either int or float) to the corresponding Go double-precision float.

func (StarlarkValue) AsGoValue

func (e StarlarkValue) AsGoValue() (interface{}, error)

func (StarlarkValue) AsInt64

func (e StarlarkValue) AsInt64() (int64, error)

func (StarlarkValue) AsString

func (e StarlarkValue) AsString() (string, error)

type StarlarkValueToGoValueConversion

type StarlarkValueToGoValueConversion interface {
	AsGoValue() (interface{}, error)
}

type UnconvertableStarlarkValue

type UnconvertableStarlarkValue interface {
	ConversionHint() string
}