config

Documentation

Index

• func Filename() string
• func Get(key string) interface{}
• func GetDuration(key string) time.Duration
• func GetEnclave(key string) *memguard.Enclave
• func GetString(key string) string
• func GetStringMapString(key string) map[string]string
• func GetUint32(key string) uint32
• func Init() error
• func IsSet(key string) bool
• func Load(configPath string) error
• func Reset()
• func Set(key string, value interface{})
• func SetDefaults(dbPath string)
• func SetFilename(filename string)
• func Write(filename string, exclusive bool) error
• func WriteStruct(filename string) error
• type Config
  • func New() *Config
  • func (c *Config) Get(key string) interface{}
  • func (c *Config) Load(filename string) error
  • func (c *Config) Set(key string, value interface{})
  • func (c *Config) Write(filename string, flags int) error

Functions

func Filename

func Filename() string

Filename returns the name of the file that the configuration is using.

func Get

func Get(key string) interface{}

Get returns an uncasted value from the config map.

func GetDuration

func GetDuration(key string) time.Duration

GetDuration returns a duration from the config map.

func GetEnclave

func GetEnclave(key string) *memguard.Enclave

GetEnclave returns an enclave from the config map.

func GetString

func GetString(key string) string

GetString returns a string from the config map.

func GetStringMapString

func GetStringMapString(key string) map[string]string

GetStringMapString returns a map[string]string from the config map.

func GetUint32

func GetUint32(key string) uint32

GetUint32 returns an uint32 from the config map.

func Init

func Init() error

Init intializes the configuration.

func IsSet

func IsSet(key string) bool

IsSet returns if the key exists in the config map or not.

func Load

func Load(configPath string) error

Load reads the configuration file and populates the map.

func Reset

func Reset()

Reset sets config to its initial value.

func Set

func Set(key string, value interface{})

Set sets a value to the config map.

func SetDefaults

func SetDefaults(dbPath string)

SetDefaults populates the config map with the default values.

func SetFilename

func SetFilename(filename string)

SetFilename sets the configuration filename.

func Write

func Write(filename string, exclusive bool) error

Write encodes and writes the config map to the specified file.

If exclusive is true an error will be returned if the file already exists, otherwise it will truncate the file and write to it.

func WriteStruct

func WriteStruct(filename string) error

WriteStruct writes the configuration empty structure to the given file.

Types

type Config

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

Config contains the elements for handling the configuration.

func New

func New() *Config

New returns a new Config.

func (*Config) Get

func (c *Config) Get(key string) interface{}

Get the value mapped to the specified key.

func (*Config) Load

func (c *Config) Load(filename string) error

Load reads the file and populates the config map.

func (*Config) Set

func (c *Config) Set(key string, value interface{})

Set sets a value for the key passed.

func (*Config) Write

func (c *Config) Write(filename string, flags int) error

Write creates a new file and writes the configuration map content to it.