settings

Documentation

Index

• Variables
• type Settings
  • func (s *Settings) Copy() Settings
  • func (s *Settings) OverrideWith(other Settings)
  • func (s *Settings) SetDefaults()
  • func (s Settings) String() string
  • func (s *Settings) Validate() error

Variables

var (
	ErrNameContainsSpace = errors.New("name contains a space")
)

Types

type Settings

type Settings struct {
	Enabled *bool
	Names   []string
}

Settings holds all the settings.

func (*Settings) Copy

func (s *Settings) Copy() Settings

Copy returns a copy of the settings.

func (*Settings) OverrideWith

func (s *Settings) OverrideWith(other Settings)

OverrideWith overrides the settings with another settings struct.

func (*Settings) SetDefaults

func (s *Settings) SetDefaults()

SetDefaults sets the default values for the settings if they are not already set.

func (Settings) String

func (s Settings) String() string

String returns a string representation of the settings.

func (*Settings) Validate

func (s *Settings) Validate() error

Validate validates the settings and returns an error if one setting is not valid.