experiments

Documentation

Index

• func Parse(dir string)
• func Validate() error
• type Experiment
  • func List() []Experiment
  • func New(xName string, config *ast.TaskRC, allowedValues ...int) Experiment
  • func (x Experiment) Active() bool
  • func (x Experiment) Enabled() bool
  • func (x Experiment) String() string
  • func (x Experiment) Valid() error
• type InactiveError
  • func (err InactiveError) Error() string
• type InvalidValueError
  • func (err InvalidValueError) Error() string

Functions

func Parse

func Parse(dir string)

func Validate

func Validate() error

Validate checks if any experiments have been enabled while being inactive. If one is found, the function returns an error.

Types

type Experiment

type Experiment struct {
	Name          string // The name of the experiment.
	AllowedValues []int  // The values that can enable this experiment.
	Value         int    // The version of the experiment that is enabled.
}

var (
	GentleForce     Experiment
	RemoteTaskfiles Experiment
	EnvPrecedence   Experiment
)

Active experiments.

var (
	AnyVariables Experiment
	MapVariables Experiment
)

Inactive experiments. These are experiments that cannot be enabled, but are preserved for error handling.

func List

func List() []Experiment

func New

func New(xName string, config *ast.TaskRC, allowedValues ...int) Experiment

New creates a new experiment with the given name and sets the values that can enable it.

func (Experiment) Active

func (x Experiment) Active() bool

func (Experiment) Enabled

func (x Experiment) Enabled() bool

func (Experiment) String

func (x Experiment) String() string

func (Experiment) Valid

func (x Experiment) Valid() error

type InactiveError

type InactiveError struct {
	Name string
}

func (InactiveError) Error

func (err InactiveError) Error() string

type InvalidValueError

type InvalidValueError struct {
	Name          string
	AllowedValues []int
	Value         int
}

func (InvalidValueError) Error

func (err InvalidValueError) Error() string