config

Documentation

Index

• Variables
• func AddConfigPath(in string)
• func AddExclude(items ...string)
• func BindPFlags(flags *pflag.FlagSet) error
• func Get(path ...string) interface{}
• func GetBool(path ...string) bool
• func GetDuration(path ...string) time.Duration
• func GetFloat(path ...string) float64
• func GetInt(path ...string) int
• func GetInt32(path ...string) int32
• func GetInt64(path ...string) int64
• func GetIntSlice(path ...string) []int
• func GetString(path ...string) string
• func GetStringMap(path ...string) map[string]interface{}
• func GetStringSlice(path ...string) []string
• func ReadConfig(in io.Reader) error
• func ReadInConfig() error
• func Set(value interface{}, path ...string)
• func SetConfigFile(in string)
• func SetConfigName(in string)
• func SetConfigType(in string)
• func Sync() error
• func SyncAs(filename string) error
• func Unmarshal(rawVal interface{}) error
• func UnmarshalKey(rawVal interface{}, path ...string) error

Variables

var FileName = "vine.yml"

FileName for global vine config, format yaml

Functions

func AddConfigPath

func AddConfigPath(in string)

AddConfigPath adds a path to search for the config file in. Can be called multiple times to define multiple search paths.

func AddExclude

func AddExclude(items ...string)

func BindPFlags

func BindPFlags(flags *pflag.FlagSet) error

BindPFlags binds a full flag set to the configuration, using each flag's long name as the config key.

func Get

func Get(path ...string) interface{}

Get a value from the config

func GetBool

func GetBool(path ...string) bool

GetBool a boolean value from the config

func GetDuration

func GetDuration(path ...string) time.Duration

GetDuration a duration value from the config

func GetFloat

func GetFloat(path ...string) float64

GetFloat a float value from the config

func GetInt

func GetInt(path ...string) int

GetInt a int64 value from the config

func GetInt32

func GetInt32(path ...string) int32

GetInt32 a int32 value from the config

func GetInt64

func GetInt64(path ...string) int64

GetInt64 a int64 value from the config

func GetIntSlice

func GetIntSlice(path ...string) []int

GetIntSlice a int slice value from the config

func GetString

func GetString(path ...string) string

GetString a string value from the config

func GetStringMap

func GetStringMap(path ...string) map[string]interface{}

GetStringMap a string map value from the config

func GetStringSlice

func GetStringSlice(path ...string) []string

GetStringSlice a string slice value from the config

func ReadConfig

func ReadConfig(in io.Reader) error

ReadConfig reads a new configuration with an existing config.

func ReadInConfig

func ReadInConfig() error

ReadInConfig will discover and load the configuration file from disk and key/value stores, searching in one of the defined paths.

func Set

func Set(value interface{}, path ...string)

Set a value in the config

func SetConfigFile

func SetConfigFile(in string)

SetConfigFile explicitly defines the path, name and extension of the config file.

func SetConfigName

func SetConfigName(in string)

SetConfigName sets name for the config file. Does not include extension.

func SetConfigType

func SetConfigType(in string)

SetConfigType sets the type of the configuration returned by the remote source, e.g. "json".

func Sync

func Sync() error

Sync apply value to .vine config

func SyncAs

func SyncAs(filename string) error

SyncAs writes current configuration to a given filename.

func Unmarshal

func Unmarshal(rawVal interface{}) error

Unmarshal unmarshals the config into a Struct. Make sure that the tags on the fields of the structure are properly set.

func UnmarshalKey

func UnmarshalKey(rawVal interface{}, path ...string) error

UnmarshalKey takes a single key and unmarshals it into a Struct.