variables

Documentation

Index

• func WithEnv() option
• func WithOther(v Variables) option
• func WithRaw(v map[string]interface{}) option
• func WithVars(v map[string]interface{}) option
• type Variables
  • func New(opts ...option) Variables
  • func (v Variables) DeepCopy() Variables
  • func (v Variables) MarshalYAML() (interface{}, error)
  • func (v Variables) Merge(other Variables) Variables
  • func (v Variables) Raw() map[string]interface{}
  • func (v *Variables) UnmarshalYAML(value *yaml.Node) error

Functions

func WithEnv

func WithEnv() option

WithEnv takes all the available environment variables and puts them in the environment namespace of the new Variables instance

func WithOther

func WithOther(v Variables) option

WithOther places the provided map in the variables namespace of the Variables

func WithRaw

func WithRaw(v map[string]interface{}) option

WithRaw places the provided map as the underlying data of the Variables

func WithVars

func WithVars(v map[string]interface{}) option

WithVars places the provided map in the variables namespace of the Variables

Types

type Variables

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

func New

func New(opts ...option) Variables

New returns a new Variables instance that has the provided map set as the main variables namespace and an empty environment namespace

func (Variables) DeepCopy

func (v Variables) DeepCopy() Variables

func (Variables) MarshalYAML

func (v Variables) MarshalYAML() (interface{}, error)

func (Variables) Merge

func (v Variables) Merge(other Variables) Variables

Merge another variable instance with this one and return a copy of the result not modifying the original set of variables

func (Variables) Raw

func (v Variables) Raw() map[string]interface{}

Raw is the underlying map[string]interface{} representation of the vars

func (*Variables) UnmarshalYAML

func (v *Variables) UnmarshalYAML(value *yaml.Node) error