config

Documentation

Index

• Constants
• type Configs
• type Manager
  • func NewManager(ritHome string) Manager
  • func (m Manager) Read() (Configs, error)
  • func (m Manager) Write(configs Configs) error
• type Reader
• type Writer

Constants

const (
	File            = "configs.toml"
	DefaultLang     = "English"
	DefaultTutorial = "enabled"
	DefaultMetrics  = "yes"
	DefaultRunType  = formula.DockerRun
)

Types

type Configs

type Configs struct {
	Language string             `toml:"language"`
	Tutorial string             `toml:"tutorial"`
	Metrics  string             `toml:"metrics"`
	RunType  formula.RunnerType `toml:"runType"`
}

type Manager

type Manager struct {
	ConfigsPath string
}

func NewManager

func NewManager(ritHome string) Manager

func (Manager) Read

func (m Manager) Read() (Configs, error)

Read reads the Configs file inside the .rit home dir If configs.toml does not exist it's return a default value and error == nil:

Configs{
		Language: DefaultLang,
		Tutorial: DefaultTutorial,
		Metrics:  DefaultMetrics,
		RunType:  DefaultRunType,
	}

in case of an error decoding the error != nil

func (Manager) Write

func (m Manager) Write(configs Configs) error

Write creates or update the ritchie configuration. Case success the error == nil

type Reader

type Reader interface {
	Read() (Configs, error)
}

type Writer

type Writer interface {
	Write(configs Configs) error
}