config

Documentation

Overview

Copyright 2022, Pulumi Corporation. All rights reserved.

Handle configuration types.

Index

• Variables
• func IsValidType(c Type) bool
• type HeterogeneousListErr
  • func (e *HeterogeneousListErr) Error() string
  • func (e *HeterogeneousListErr) Is(err error) bool
• type Type
  • func Parse(s string) (Type, bool)
  • func TypeValue(v interface{}) (Type, error)
• type Types
  • func (c Types) String() string
• type UnexpectedTypeErr
  • func (e *UnexpectedTypeErr) Error() string
  • func (e *UnexpectedTypeErr) Is(err error) bool

Variables

var (
	String      Type = typ{schema.StringType}
	StringList       = typ{&schema.ArrayType{ElementType: schema.StringType}}
	Number           = typ{schema.NumberType}
	NumberList       = typ{&schema.ArrayType{ElementType: schema.NumberType}}
	Boolean          = typ{schema.BoolType}
	BooleanList      = typ{&schema.ArrayType{ElementType: schema.NumberType}}
	Int              = typ{schema.IntType}
	IntList          = typ{&schema.ArrayType{ElementType: schema.IntType}}
)

var (
	ErrHeterogeneousList = HeterogeneousListErr{}
	ErrEmptyList         = fmt.Errorf("empty list")
	ErrUnexpectedType    = UnexpectedTypeErr{}
)

var ConfigTypes = Types{
	String,
	StringList,
	Number,
	NumberList,
	Int,
	IntList,
	Boolean,
	BooleanList,
}

var Primitives = Types{
	String,
	Number,
	Int,
	Boolean,
}

Functions

func IsValidType

func IsValidType(c Type) bool

Types

type HeterogeneousListErr

type HeterogeneousListErr struct {
	T1 Type
	T2 Type
}

func (*HeterogeneousListErr) Error

func (e *HeterogeneousListErr) Error() string

func (*HeterogeneousListErr) Is

func (e *HeterogeneousListErr) Is(err error) bool

type Type

type Type interface {
	fmt.Stringer
	// Return the schema equivalent of this type
	Schema() schema.Type
	// Return the pcl equivalent of this type
	Pcl() model.Type
	// contains filtered or unexported methods
}

func Parse

func Parse(s string) (Type, bool)

func TypeValue

func TypeValue(v interface{}) (Type, error)

Type a go value into a configuration value. If an error is returned, it is one of - ErrHeterogeneousList - ErrEmptyList - ErrUnexpectedType

type Types

type Types []Type

func (Types) String

func (c Types) String() string

type UnexpectedTypeErr

type UnexpectedTypeErr struct {
	T interface{}
}

func (*UnexpectedTypeErr) Error

func (e *UnexpectedTypeErr) Error() string

func (*UnexpectedTypeErr) Is

func (e *UnexpectedTypeErr) Is(err error) bool