Documentation
¶
Overview ¶
Package concurrentviper is a generated thread-safe wrapper for github.com/spf13/viper
nolint
Index ¶
- func AddConfigPath(in string)
- func AddRemoteProvider(provider, endpoint, path string) error
- func AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error
- func AllKeys() []string
- func AllSettings() map[string]interface{}
- func AllowEmptyEnv(allowEmptyEnv bool)
- func AutomaticEnv()
- func BindEnv(input ...string) error
- func BindFlagValue(key string, flag viper.FlagValue) error
- func BindFlagValues(flags viper.FlagValueSet) error
- func BindPFlag(key string, flag *pflag.Flag) error
- func BindPFlags(flags *pflag.FlagSet) error
- func ConfigFileUsed() string
- func Debug()
- func DecodeHook(hook mapstructure.DecodeHookFunc) viper.DecoderConfigOption
- func EnvKeyReplacer(r viper.StringReplacer) viper.Option
- func Get(key string) interface{}
- func GetBool(key string) bool
- func GetDuration(key string) time.Duration
- func GetFloat64(key string) float64
- func GetInt(key string) int
- func GetInt32(key string) int32
- func GetInt64(key string) int64
- func GetIntSlice(key string) []int
- func GetSizeInBytes(key string) uint
- func GetString(key string) string
- func GetStringMap(key string) map[string]interface{}
- func GetStringMapString(key string) map[string]string
- func GetStringMapStringSlice(key string) map[string][]string
- func GetStringSlice(key string) []string
- func GetTime(key string) time.Time
- func GetUint(key string) uint
- func GetUint32(key string) uint32
- func GetUint64(key string) uint64
- func GetViper() *viper.Viper
- func InConfig(key string) bool
- func IsSet(key string) bool
- func KeyDelimiter(d string) viper.Option
- func MergeConfig(in io.Reader) error
- func MergeConfigMap(cfg map[string]interface{}) error
- func MergeInConfig() error
- func New() *viper.Viper
- func NewWithOptions(opts ...viper.Option) *viper.Viper
- func OnConfigChange(run func(in fsnotify.Event))
- func ReadConfig(in io.Reader) error
- func ReadInConfig() error
- func ReadRemoteConfig() error
- func RegisterAlias(alias string, key string)
- func Reset()
- func SafeWriteConfig() error
- func SafeWriteConfigAs(filename string) error
- func Set(key string, value interface{})
- func SetConfigFile(in string)
- func SetConfigName(in string)
- func SetConfigPermissions(perm os.FileMode)
- func SetConfigType(in string)
- func SetDefault(key string, value interface{})
- func SetEnvKeyReplacer(r *strings.Replacer)
- func SetEnvPrefix(in string)
- func SetFs(fs afero.Fs)
- func SetTypeByDefaultValue(enable bool)
- func Sub(key string) *viper.Viper
- func Unmarshal(rawVal interface{}, opts ...viper.DecoderConfigOption) error
- func UnmarshalExact(rawVal interface{}, opts ...viper.DecoderConfigOption) error
- func UnmarshalKey(key string, rawVal interface{}, opts ...viper.DecoderConfigOption) error
- func WatchConfig()
- func WatchRemoteConfig() error
- func WriteConfig() error
- func WriteConfigAs(filename string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddConfigPath ¶
func AddConfigPath(in string)
AddConfigPath adds a path for Viper to search for the config file in. Can be called multiple times to define multiple search paths. This function is safe for concurrent use.
func AddRemoteProvider ¶
AddRemoteProvider adds a remote configuration source. Remote Providers are searched in the order they are added. provider is a string value: "etcd", "consul" or "firestore" are currently supported. endpoint is the url. etcd requires http://ip:port consul requires ip:port path is the path in the k/v store to retrieve configuration To retrieve a config file called myapp.json from /configs/myapp.json you should set path to /configs and set config name (SetConfigName()) to "myapp" This function is safe for concurrent use.
func AddSecureRemoteProvider ¶
AddSecureRemoteProvider adds a remote configuration source. Secure Remote Providers are searched in the order they are added. provider is a string value: "etcd", "consul" or "firestore" are currently supported. endpoint is the url. etcd requires http://ip:port consul requires ip:port secretkeyring is the filepath to your openpgp secret keyring. e.g. /etc/secrets/myring.gpg path is the path in the k/v store to retrieve configuration To retrieve a config file called myapp.json from /configs/myapp.json you should set path to /configs and set config name (SetConfigName()) to "myapp" Secure Remote Providers are implemented with github.com/bketelsen/crypt This function is safe for concurrent use.
func AllKeys ¶
func AllKeys() []string
AllKeys returns all keys holding a value, regardless of where they are set. Nested keys are returned with a v.keyDelim separator This function is safe for concurrent use.
func AllSettings ¶
func AllSettings() map[string]interface{}
AllSettings merges all settings and returns them as a map[string]interface{}. This function is safe for concurrent use.
func AllowEmptyEnv ¶
func AllowEmptyEnv(allowEmptyEnv bool)
AllowEmptyEnv tells Viper to consider set, but empty environment variables as valid values instead of falling back. For backward compatibility reasons this is false by default. This function is safe for concurrent use.
func AutomaticEnv ¶
func AutomaticEnv()
AutomaticEnv has Viper check ENV variables for all. keys set in config, default & flags This function is safe for concurrent use.
func BindEnv ¶
BindEnv binds a Viper key to a ENV variable. ENV variables are case sensitive. If only a key is provided, it will use the env key matching the key, uppercased. EnvPrefix will be used when set when env name is not provided. This function is safe for concurrent use.
func BindFlagValue ¶
BindFlagValue binds a specific key to a FlagValue. This function is safe for concurrent use.
func BindFlagValues ¶
func BindFlagValues(flags viper.FlagValueSet) error
BindFlagValues binds a full FlagValue set to the configuration, using each flag's long name as the config key. This function is safe for concurrent use.
func BindPFlag ¶
BindPFlag binds a specific key to a pflag (as used by cobra). Example (where serverCmd is a Cobra instance):
serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
Viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))
This function is safe for concurrent use.
func BindPFlags ¶
BindPFlags binds a full flag set to the configuration, using each flag's long name as the config key. This function is safe for concurrent use.
func ConfigFileUsed ¶
func ConfigFileUsed() string
ConfigFileUsed returns the file used to populate the config registry. This function is safe for concurrent use.
func Debug ¶
func Debug()
Debug prints all configuration registries for debugging purposes. This function is safe for concurrent use.
func DecodeHook ¶
func DecodeHook(hook mapstructure.DecodeHookFunc) viper.DecoderConfigOption
DecodeHook returns a DecoderConfigOption which overrides the default DecoderConfig.DecodeHook value, the default is:
mapstructure.ComposeDecodeHookFunc(
mapstructure.StringToTimeDurationHookFunc(),
mapstructure.StringToSliceHookFunc(","),
)
This function is safe for concurrent use.
func EnvKeyReplacer ¶
func EnvKeyReplacer(r viper.StringReplacer) viper.Option
EnvKeyReplacer sets a replacer used for mapping environment variables to internal keys. This function is safe for concurrent use.
func Get ¶
func Get(key string) interface{}
Get can retrieve any value given the key to use. Get is case-insensitive for a key. Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: override, flag, env, config file, key/value store, default
Get returns an interface. For a specific value use one of the Get____ methods. This function is safe for concurrent use.
func GetBool ¶
GetBool returns the value associated with the key as a boolean. This function is safe for concurrent use.
func GetDuration ¶
GetDuration returns the value associated with the key as a duration. This function is safe for concurrent use.
func GetFloat64 ¶
GetFloat64 returns the value associated with the key as a float64. This function is safe for concurrent use.
func GetInt ¶
GetInt returns the value associated with the key as an integer. This function is safe for concurrent use.
func GetInt32 ¶
GetInt32 returns the value associated with the key as an integer. This function is safe for concurrent use.
func GetInt64 ¶
GetInt64 returns the value associated with the key as an integer. This function is safe for concurrent use.
func GetIntSlice ¶
GetIntSlice returns the value associated with the key as a slice of int values. This function is safe for concurrent use.
func GetSizeInBytes ¶
GetSizeInBytes returns the size of the value associated with the given key in bytes. This function is safe for concurrent use.
func GetString ¶
GetString returns the value associated with the key as a string. This function is safe for concurrent use.
func GetStringMap ¶
GetStringMap returns the value associated with the key as a map of interfaces. This function is safe for concurrent use.
func GetStringMapString ¶
GetStringMapString returns the value associated with the key as a map of strings. This function is safe for concurrent use.
func GetStringMapStringSlice ¶
GetStringMapStringSlice returns the value associated with the key as a map to a slice of strings. This function is safe for concurrent use.
func GetStringSlice ¶
GetStringSlice returns the value associated with the key as a slice of strings. This function is safe for concurrent use.
func GetTime ¶
GetTime returns the value associated with the key as time. This function is safe for concurrent use.
func GetUint ¶
GetUint returns the value associated with the key as an unsigned integer. This function is safe for concurrent use.
func GetUint32 ¶
GetUint32 returns the value associated with the key as an unsigned integer. This function is safe for concurrent use.
func GetUint64 ¶
GetUint64 returns the value associated with the key as an unsigned integer. This function is safe for concurrent use.
func InConfig ¶
InConfig checks to see if the given key (or an alias) is in the config file. This function is safe for concurrent use.
func IsSet ¶
IsSet checks to see if the key has been set in any of the data locations. IsSet is case-insensitive for a key. This function is safe for concurrent use.
func KeyDelimiter ¶
KeyDelimiter sets the delimiter used for determining key parts. By default it's value is ".". This function is safe for concurrent use.
func MergeConfig ¶
MergeConfig merges a new configuration with an existing config. This function is safe for concurrent use.
func MergeConfigMap ¶
MergeConfigMap merges the configuration from the map given with an existing config. Note that the map given may be modified. This function is safe for concurrent use.
func MergeInConfig ¶
func MergeInConfig() error
MergeInConfig merges a new configuration with an existing config. This function is safe for concurrent use.
func NewWithOptions ¶
NewWithOptions creates a new Viper instance. This function is safe for concurrent use.
func OnConfigChange ¶
This function is safe for concurrent use.
func ReadConfig ¶
ReadConfig will read a configuration file, setting existing keys to nil if the key does not exist in the file. This function is safe for concurrent use.
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. This function is safe for concurrent use.
func ReadRemoteConfig ¶
func ReadRemoteConfig() error
ReadRemoteConfig attempts to get configuration from a remote source and read it in the remote configuration registry. This function is safe for concurrent use.
func RegisterAlias ¶
RegisterAlias creates an alias that provides another accessor for the same key. This enables one to change a name without breaking the application. This function is safe for concurrent use.
func Reset ¶
func Reset()
Reset is intended for testing, will reset all to default settings. In the public interface for the viper package so applications can use it in their testing as well. This function is safe for concurrent use.
func SafeWriteConfig ¶
func SafeWriteConfig() error
SafeWriteConfig writes current configuration to file only if the file does not exist. This function is safe for concurrent use.
func SafeWriteConfigAs ¶
SafeWriteConfigAs writes current configuration to a given filename if it does not exist. This function is safe for concurrent use.
func Set ¶
func Set(key string, value interface{})
Set sets the value for the key in the override register. Set is case-insensitive for a key. Will be used instead of values obtained via flags, config file, ENV, default, or key/value store. This function is safe for concurrent use.
func SetConfigFile ¶
func SetConfigFile(in string)
SetConfigFile explicitly defines the path, name and extension of the config file. Viper will use this and not check any of the config paths. This function is safe for concurrent use.
func SetConfigName ¶
func SetConfigName(in string)
SetConfigName sets name for the config file. Does not include extension. This function is safe for concurrent use.
func SetConfigPermissions ¶
SetConfigPermissions sets the permissions for the config file. This function is safe for concurrent use.
func SetConfigType ¶
func SetConfigType(in string)
SetConfigType sets the type of the configuration returned by the remote source, e.g. "json". This function is safe for concurrent use.
func SetDefault ¶
func SetDefault(key string, value interface{})
SetDefault sets the default value for this key. SetDefault is case-insensitive for a key. Default only used when no value is provided by the user via flag, config or ENV. This function is safe for concurrent use.
func SetEnvKeyReplacer ¶
SetEnvKeyReplacer sets the strings.Replacer on the viper object Useful for mapping an environmental variable to a key that does not match it. This function is safe for concurrent use.
func SetEnvPrefix ¶
func SetEnvPrefix(in string)
SetEnvPrefix defines a prefix that ENVIRONMENT variables will use. E.g. if your prefix is "spf", the env registry will look for env variables that start with "SPF_". This function is safe for concurrent use.
func SetFs ¶
SetFs sets the filesystem to use to read configuration. This function is safe for concurrent use.
func SetTypeByDefaultValue ¶
func SetTypeByDefaultValue(enable bool)
SetTypeByDefaultValue enables or disables the inference of a key value's type when the Get function is used based upon a key's default value as opposed to the value returned based on the normal fetch logic.
For example, if a key has a default value of []string{} and the same key is set via an environment variable to "a b c", a call to the Get function would return a string slice for the key if the key's type is inferred by the default value and the Get function would return:
[]string {"a", "b", "c"}
Otherwise the Get function would return:
"a b c"
This function is safe for concurrent use.
func Sub ¶
Sub returns new Viper instance representing a sub tree of this instance. Sub is case-insensitive for a key. This function is safe for concurrent use.
func Unmarshal ¶
func Unmarshal(rawVal interface{}, opts ...viper.DecoderConfigOption) error
Unmarshal unmarshals the config into a Struct. Make sure that the tags on the fields of the structure are properly set. This function is safe for concurrent use.
func UnmarshalExact ¶
func UnmarshalExact(rawVal interface{}, opts ...viper.DecoderConfigOption) error
UnmarshalExact unmarshals the config into a Struct, erroring if a field is nonexistent in the destination struct. This function is safe for concurrent use.
func UnmarshalKey ¶
func UnmarshalKey(key string, rawVal interface{}, opts ...viper.DecoderConfigOption) error
UnmarshalKey takes a single key and unmarshals it into a Struct. This function is safe for concurrent use.
func WriteConfig ¶
func WriteConfig() error
WriteConfig writes the current configuration to a file. This function is safe for concurrent use.
func WriteConfigAs ¶
WriteConfigAs writes current configuration to a given filename. This function is safe for concurrent use.
Types ¶
This section is empty.
Source Files
Directories