config_selector

README

config_selector

Configuration file selector for go

Documentation

Index

• type ConfigFileSelector
  • func NewConfigFileSelector(fileName string, a ...LookupPlace) *ConfigFileSelector
  • func (s *ConfigFileSelector) AddLookupPlace(place LookupPlace)
  • func (s *ConfigFileSelector) IsFileExists(path string) (bool, error)
  • func (s *ConfigFileSelector) LookupFilePathList() (*[]string, error)
  • func (s *ConfigFileSelector) LookupFolderList() (*[]string, error)
  • func (s *ConfigFileSelector) SelectFirstKnownPlace() (*string, error)
  • func (s *ConfigFileSelector) SelectPath(path string) (*string, error)
  • func (s *ConfigFileSelector) String() string
  • func (s *ConfigFileSelector) UseEtc()
  • func (s *ConfigFileSelector) UseEtcProgramFolder(programName string)
• type LookupPlace
• type SearchPlaces

Types

type ConfigFileSelector

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

func NewConfigFileSelector

func NewConfigFileSelector(fileName string, a ...LookupPlace) *ConfigFileSelector

Make new configuration loader for required lookup using search places flags

func (*ConfigFileSelector) AddLookupPlace

func (s *ConfigFileSelector) AddLookupPlace(place LookupPlace)

Add lookup place

func (*ConfigFileSelector) IsFileExists

func (s *ConfigFileSelector) IsFileExists(path string) (bool, error)

Check if file specified by full path is exists

func (*ConfigFileSelector) LookupFilePathList

func (s *ConfigFileSelector) LookupFilePathList() (*[]string, error)

Get possible configuration file path list using lookup places in order set by lookup flags

func (*ConfigFileSelector) LookupFolderList

func (s *ConfigFileSelector) LookupFolderList() (*[]string, error)

Get well-known path list for searching config file's

Returns a list of well-known directories in order set by lookup flags

func (*ConfigFileSelector) SelectFirstKnownPlace

func (s *ConfigFileSelector) SelectFirstKnownPlace() (*string, error)

Get first existing configuration file path from places set by lookup flags

func (*ConfigFileSelector) SelectPath

func (s *ConfigFileSelector) SelectPath(path string) (*string, error)

Find configuration file in path or well known path list defined by lookup flags

func (*ConfigFileSelector) String

func (s *ConfigFileSelector) String() string

func (*ConfigFileSelector) UseEtc

func (s *ConfigFileSelector) UseEtc()

Add /etc/ path

func (*ConfigFileSelector) UseEtcProgramFolder

func (s *ConfigFileSelector) UseEtcProgramFolder(programName string)

Add /etc/<program name>/ path

type LookupPlace

type LookupPlace string

const (
	HomeDir     LookupPlace = "Home"
	UserConfig  LookupPlace = ".config"
	CurrentPath LookupPlace = "./"
	Etc         LookupPlace = "/etc"
)

type SearchPlaces

type SearchPlaces []LookupPlace