toggle

README

Go Toggle

Simple library to add toggleable pieces of code that can be switched on or off in runtime or just at boot time

Documentation

Index

• Constants
• func Add(name string, options ...func() error) error
• func Execute(name string) error
• func Run(name string, options ...func() error) error
• func Toggle(name string, toggle int) error

Examples

• Run

Constants

const (
	ToggleableExistsError   = err.Error("toggleable already exists")
	NotEnoughOptionsError   = err.Error("toggleables need at least 2 options to toggle")
	ToggleableNotFoundError = err.Error("toggleable does not exist")
	InvalidToggleError      = err.Error("toggle value is out of bounds for the toggleable")
)

Functions

func Add

func Add(name string, options ...func() error) error

func Execute

func Execute(name string) error

func Run

func Run(name string, options ...func() error) error

Example

os.Args = []string{"app", "-TExampleRun", "1"}
env.Load() // For testing purposes the environment has to be reloaded after updating the cml arguments
_ = Add("ExampleRun", func() error {
	fmt.Println("1")
	return nil
}, func() error {
	fmt.Println("2")
	return nil
})
_ = Execute("ExampleRun")
_ = Toggle("ExampleRun", 0)
_ = Execute("ExampleRun")
_ = Run("ExampleRun", func() error {
	fmt.Println("2")
	return nil
}, func() error {
	fmt.Println("1")
	return nil
})

Output:

2
1
2

func Toggle

func Toggle(name string, toggle int) error