profile

Documentation

Overview

Package profile handles profiled settings.

Index

• type Profile
  • func New() *Profile
  • func (p *Profile) GetConfigFile() string
  • func (p *Profile) GetPath(name string) string
  • func (p *Profile) GetRundir() string
  • func (p *Profile) GetRundirPath(name string) string
  • func (p *Profile) ListConfigFiles() []string
  • func (p *Profile) Setup() error
  • func (p *Profile) String() string

Types

type Profile

type Profile struct {
	Name       string
	Home       string
	Config     string
	ConfigFile string
	Run        string
}

Profile holds the profile settings.

func New

func New() *Profile

New creates a new object with defaults values set.

func (*Profile) GetConfigFile

func (p *Profile) GetConfigFile() string

GetConfigFile returns the absolute filename of the configuration file for the current os user. This is the filename used to save configuration updates.

func (*Profile) GetPath

func (p *Profile) GetPath(name string) string

GetPath returns the absolute profile named filepath.

func (*Profile) GetRundir

func (p *Profile) GetRundir() string

GetRundir returns the profile named rundir path.

func (*Profile) GetRundirPath

func (p *Profile) GetRundirPath(name string) string

GetRundirPath returns an absolute rundir profile named filepath.

func (*Profile) ListConfigFiles

func (p *Profile) ListConfigFiles() []string

ListConfigFiles returns a list of all the profiled filenames to read the configuration from.

func (*Profile) Setup

func (p *Profile) Setup() error

Setup checks runtime setup requirements.

func (*Profile) String

func (p *Profile) String() string

String returns profile base path. But just for info/debug purposes. It will always be slash (/) separated.