config

package
v2.6.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 3, 2022 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var RemoteConfig remoteConfigFactory

RemoteConfig is optional, see the remote package

View Source 
var SupportedExts = []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"}

SupportedExts are universally supported extensions.

View Source 
var SupportedRemoteProviders = []string{"etcd", "consul", "firestore"}

SupportedRemoteProviders are universally supported remote providers.

Functions

func AddConfigPath added in v2.5.2 

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.

func AddRemoteProvider added in v2.5.2 

func AddRemoteProvider(provider, endpoint, path string) error

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"

func AddSecureRemoteProvider added in v2.5.2 

func AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error

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

func AllKeys added in v2.5.2 

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

func AllSettings added in v2.5.2 

func AllSettings() map[string]interface{}

AllSettings merges all settings and returns them as a map[string]interface{}.

func AllowEmptyEnv added in v2.5.2 

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.

func AutomaticEnv added in v2.5.2 

func AutomaticEnv()

AutomaticEnv makes Viper check if environment variables match any of the existing keys (config, default or flags). If matching env vars are found, they are loaded into Viper.

func BindEnv added in v2.5.2 

func BindEnv(input ...string) error

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. If more arguments are provided, they will represent the env variable names that should bind to this key and will be taken in the specified order. EnvPrefix will be used when set when env name is not provided.

func BindFlagValue added in v2.5.2 

func BindFlagValue(key string, flag FlagValue) error

BindFlagValue binds a specific key to a FlagValue.

func BindFlagValues added in v2.5.2 

func BindFlagValues(flags FlagValueSet) error

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

func BindPFlag added in v2.5.2 

func BindPFlag(key string, flag *pflag.Flag) error

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"))

func BindPFlags added in v2.5.2 

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 Bool 

func Bool(key string, defVal ...bool) bool

func ConfigFileUsed added in v2.5.2 

func ConfigFileUsed() string

ConfigFileUsed returns the file used to populate the config registry.

func Debug added in v2.5.2 

func Debug()

Debug prints all configuration registries for debugging purposes.

func Float 

func Float(key string, defVal ...float64) float64

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.

func GetBool added in v2.5.2 

func GetBool(key string) bool

GetBool returns the value associated with the key as a boolean.

func GetDuration added in v2.5.2 

func GetDuration(key string) time.Duration

GetDuration returns the value associated with the key as a duration.

func GetFloat64 added in v2.5.2 

func GetFloat64(key string) float64

GetFloat64 returns the value associated with the key as a float64.

func GetInt added in v2.5.2 

func GetInt(key string) int

GetInt returns the value associated with the key as an integer.

func GetInt32 added in v2.5.2 

func GetInt32(key string) int32

GetInt32 returns the value associated with the key as an integer.

func GetInt64 added in v2.5.2 

func GetInt64(key string) int64

GetInt64 returns the value associated with the key as an integer.

func GetIntSlice added in v2.5.2 

func GetIntSlice(key string) []int

GetIntSlice returns the value associated with the key as a slice of int values.

func GetSizeInBytes added in v2.5.2 

func GetSizeInBytes(key string) uint

GetSizeInBytes returns the size of the value associated with the given key in bytes.

func GetString added in v2.5.2 

func GetString(key string) string

GetString returns the value associated with the key as a string.

func GetStringMap added in v2.5.2 

func GetStringMap(key string) map[string]interface{}

GetStringMap returns the value associated with the key as a map of interfaces.

func GetStringMapString added in v2.5.2 

func GetStringMapString(key string) map[string]string

GetStringMapString returns the value associated with the key as a map of strings.

func GetStringMapStringSlice added in v2.5.2 

func GetStringMapStringSlice(key string) map[string][]string

GetStringMapStringSlice returns the value associated with the key as a map to a slice of strings.

func GetStringSlice added in v2.5.2 

func GetStringSlice(key string) []string

GetStringSlice returns the value associated with the key as a slice of strings.

func GetTime added in v2.5.2 

func GetTime(key string) time.Time

GetTime returns the value associated with the key as time.

func GetUint added in v2.5.2 

func GetUint(key string) uint

GetUint returns the value associated with the key as an unsigned integer.

func GetUint32 added in v2.5.2 

func GetUint32(key string) uint32

GetUint32 returns the value associated with the key as an unsigned integer.

func GetUint64 added in v2.5.2 

func GetUint64(key string) uint64

GetUint64 returns the value associated with the key as an unsigned integer.

func InConfig added in v2.5.2 

func InConfig(key string) bool

InConfig checks to see if the given key (or an alias) is in the config file.

func Int 

func Int(key string, defVal ...int) int

func Int64 

func Int64(key string, defVal ...int64) int64

func IntMap 

func IntMap(key string) map[string]int

func Ints 

func Ints(key string) []int

func IsSet added in v2.5.2 

func IsSet(key string) bool

IsSet checks to see if the key has been set in any of the data locations. IsSet is case-insensitive for a key.

func MergeConfig added in v2.5.2 

func MergeConfig(in io.Reader) error

MergeConfig merges a new configuration with an existing config.

func MergeConfigMap added in v2.5.2 

func MergeConfigMap(cfg map[string]interface{}) error

MergeConfigMap merges the configuration from the map given with an existing config. Note that the map given may be modified.

func MergeInConfig added in v2.5.2 

func MergeInConfig() error

MergeInConfig merges a new configuration with an existing config.

func OnConfigChange added in v2.5.2 

func OnConfigChange(run func(in fsnotify.Event))

func ReadConfig added in v2.5.2 

func ReadConfig(in io.Reader) error

ReadConfig will read a configuration file, setting existing keys to nil if the key does not exist in the file.

func ReadInConfig added in v2.5.2 

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 ReadRemoteConfig added in v2.5.2 

func ReadRemoteConfig() error

ReadRemoteConfig attempts to get configuration from a remote source and read it in the remote configuration registry.

func RegisterAlias added in v2.5.2 

func RegisterAlias(alias string, key string)

RegisterAlias creates an alias that provides another accessor for the same key. This enables one to change a name without breaking the application.

func Reset added in v2.5.2 

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.

func SafeWriteConfig added in v2.5.2 

func SafeWriteConfig() error

SafeWriteConfig writes current configuration to file only if the file does not exist.

func SafeWriteConfigAs added in v2.5.2 

func SafeWriteConfigAs(filename string) error

SafeWriteConfigAs writes current configuration to a given filename if it does not exist.

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.

func SetConfigFile added in v2.5.2 

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.

func SetConfigName added in v2.5.2 

func SetConfigName(in string)

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

func SetConfigPermissions added in v2.5.2 

func SetConfigPermissions(perm os.FileMode)

SetConfigPermissions sets the permissions for the config file.

func SetConfigType added in v2.5.2 

func SetConfigType(in string)

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

func SetDefault added in v2.5.2 

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.

func SetEnvKeyReplacer added in v2.5.2 

func SetEnvKeyReplacer(r *strings.Replacer)

SetEnvKeyReplacer sets the strings.Replacer on the viper object Useful for mapping an environmental variable to a key that does not match it.

func SetEnvPrefix added in v2.5.2 

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_".

func SetFs added in v2.5.2 

func SetFs(fs afero.Fs)

SetFs sets the filesystem to use to read configuration.

func SetTypeByDefaultValue added in v2.5.2 

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"

func String 

func String(key string, defVal ...string) string

func StringMap 

func StringMap(key string) map[string]string

func Strings 

func Strings(key string) []string

func Uint 

func Uint(key string, defVal ...uint) uint

func Unmarshal added in v2.5.2 

func Unmarshal(rawVal interface{}, opts ...DecoderConfigOption) error

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

func UnmarshalExact added in v2.5.2 

func UnmarshalExact(rawVal interface{}, opts ...DecoderConfigOption) error

UnmarshalExact unmarshals the config into a Struct, erroring if a field is nonexistent in the destination struct.

func UnmarshalKey added in v2.5.2 

func UnmarshalKey(key string, rawVal interface{}, opts ...DecoderConfigOption) error

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

func WatchConfig added in v2.5.2 

func WatchConfig()

func WatchRemoteConfig added in v2.5.2 

func WatchRemoteConfig() error

func WriteConfig added in v2.5.2 

func WriteConfig() error

WriteConfig writes the current configuration to a file.

func WriteConfigAs added in v2.5.2 

func WriteConfigAs(filename string) error

WriteConfigAs writes current configuration to a given filename.

Types

type ConfigFileAlreadyExistsError added in v2.5.2 

type ConfigFileAlreadyExistsError string

ConfigFileAlreadyExistsError denotes failure to write new configuration file.

func (ConfigFileAlreadyExistsError) Error added in v2.5.2 

func (faee ConfigFileAlreadyExistsError) Error() string

Error returns the formatted error when configuration already exists.

type ConfigFileNotFoundError added in v2.5.2 

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

ConfigFileNotFoundError denotes failing to find configuration file.

func (ConfigFileNotFoundError) Error added in v2.5.2 

func (fnfe ConfigFileNotFoundError) Error() string

Error returns the formatted configuration error.

type ConfigMarshalError added in v2.5.2 

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

ConfigMarshalError happens when failing to marshal the configuration.

func (ConfigMarshalError) Error added in v2.5.2 

func (e ConfigMarshalError) Error() string

Error returns the formatted configuration error.

type ConfigParseError added in v2.5.2 

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

ConfigParseError denotes failing to parse configuration file.

func (ConfigParseError) Error added in v2.5.2 

func (pe ConfigParseError) Error() string

Error returns the formatted configuration error.

type DecoderConfigOption added in v2.5.2 

type DecoderConfigOption func(*mapstructure.DecoderConfig)

A DecoderConfigOption can be passed to viper.Unmarshal to configure mapstructure.DecoderConfig options

func DecodeHook added in v2.5.2 

func DecodeHook(hook mapstructure.DecodeHookFunc) DecoderConfigOption

DecodeHook returns a DecoderConfigOption which overrides the default DecoderConfig.DecodeHook value, the default is: 

 mapstructure.ComposeDecodeHookFunc(
		mapstructure.StringToTimeDurationHookFunc(),
		mapstructure.StringToSliceHookFunc(","),
	)

type FlagValue added in v2.5.2 

type FlagValue interface {
	HasChanged() bool
	Name() string
	ValueString() string
	ValueType() string
}

FlagValue is an interface that users can implement to bind different flags to viper.

type FlagValueSet added in v2.5.2 

type FlagValueSet interface {
	VisitAll(fn func(FlagValue))
}

FlagValueSet is an interface that users can implement to bind a set of flags to viper.

type Logger added in v2.5.2 

type Logger interface {
	// Trace logs a Trace event.
	//
	// Even more fine-grained information than Debug events.
	// Loggers not supporting this level should fall back to Debug.
	Trace(msg string, keyvals ...interface{})

	// Debug logs a Debug event.
	//
	// A verbose series of information events.
	// They are useful when debugging the system.
	Debug(msg string, keyvals ...interface{})

	// Info logs an Info event.
	//
	// General information about what's happening inside the system.
	Info(msg string, keyvals ...interface{})

	// Warn logs a Warn(ing) event.
	//
	// Non-critical events that should be looked at.
	Warn(msg string, keyvals ...interface{})

	// Error logs an Error event.
	//
	// Critical events that require immediate attention.
	// Loggers commonly provide Fatal and Panic levels above Error level,
	// but exiting and panicing is out of scope for a logging library.
	Error(msg string, keyvals ...interface{})
}

Logger is a unified interface for various logging use cases and practices, including:

  • leveled logging
  • structured logging

type Option added in v2.5.2 

type Option interface {
	// contains filtered or unexported methods
}

Option configures Viper using the functional options paradigm popularized by Rob Pike and Dave Cheney. If you're unfamiliar with this style, see https://commandcenter.blogspot.com/2014/01/self-referential-functions-and-design.html and https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis.

func EnvKeyReplacer added in v2.5.2 

func EnvKeyReplacer(r StringReplacer) Option

EnvKeyReplacer sets a replacer used for mapping environment variables to internal keys.

func IniLoadOptions added in v2.5.2 

func IniLoadOptions(in ini.LoadOptions) Option

IniLoadOptions sets the load options for ini parsing.

func KeyDelimiter added in v2.5.2 

func KeyDelimiter(d string) Option

KeyDelimiter sets the delimiter used for determining key parts. By default it's value is ".".

type RemoteConfigError added in v2.5.2 

type RemoteConfigError string

RemoteConfigError denotes encountering an error while trying to pull the configuration from the remote provider.

func (RemoteConfigError) Error added in v2.5.2 

func (rce RemoteConfigError) Error() string

Error returns the formatted remote provider error

type RemoteProvider added in v2.5.2 

type RemoteProvider interface {
	Provider() string
	Endpoint() string
	Path() string
	SecretKeyring() string
}

RemoteProvider stores the configuration necessary to connect to a remote key/value store. Optional secretKeyring to unencrypt encrypted values can be provided.

type RemoteResponse added in v2.5.2 

type RemoteResponse struct {
	Value []byte
	Error error
}

type StringReplacer added in v2.5.2 

type StringReplacer interface {
	// Replace returns a copy of s with all replacements performed.
	Replace(s string) string
}

StringReplacer applies a set of replacements to a string.

type UnsupportedConfigError added in v2.5.2 

type UnsupportedConfigError string

UnsupportedConfigError denotes encountering an unsupported configuration filetype.

func (UnsupportedConfigError) Error added in v2.5.2 

func (str UnsupportedConfigError) Error() string

Error returns the formatted configuration error.

type UnsupportedRemoteProviderError added in v2.5.2 

type UnsupportedRemoteProviderError string

UnsupportedRemoteProviderError denotes encountering an unsupported remote provider. Currently only etcd and Consul are supported.

func (UnsupportedRemoteProviderError) Error added in v2.5.2 

func (str UnsupportedRemoteProviderError) Error() string

Error returns the formatted remote provider error.

type Viper added in v2.5.2 

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

Viper is a prioritized configuration registry. It maintains a set of configuration sources, fetches values to populate those, and provides them according to the source's priority. The priority of the sources is the following: 1. overrides 2. flags 3. env. variables 4. config file 5. key/value store 6. defaults

For example, if values from the following sources were loaded: 

Defaults : {
	"secret": "",
	"user": "default",
	"endpoint": "https://localhost"
}
Config : {
	"user": "root"
	"secret": "defaultsecret"
}
Env : {
	"secret": "somesecretkey"
}

The resulting config will have the following values: 

{
	"secret": "somesecretkey",
	"user": "root",
	"endpoint": "https://localhost"
}

Note: Vipers are not safe for concurrent Get() and Set() operations.

func GetViper added in v2.5.2 

func GetViper() *Viper

GetViper gets the global Viper instance.

func New 

func New() *Viper

New returns an initialized Viper instance.

func NewWithOptions 

func NewWithOptions(opts ...Option) *Viper

NewWithOptions creates a new Viper instance.

func Sub added in v2.5.2 

func Sub(key string) *Viper

Sub returns new Viper instance representing a sub tree of this instance. Sub is case-insensitive for a key.

func (*Viper) AddConfigPath added in v2.5.2 

func (v *Viper) AddConfigPath(in string)

func (*Viper) AddRemoteProvider added in v2.5.2 

func (v *Viper) AddRemoteProvider(provider, endpoint, path string) error

func (*Viper) AddSecureRemoteProvider added in v2.5.2 

func (v *Viper) AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error

func (*Viper) AllKeys added in v2.5.2 

func (v *Viper) AllKeys() []string

func (*Viper) AllSettings added in v2.5.2 

func (v *Viper) AllSettings() map[string]interface{}

func (*Viper) AllowEmptyEnv added in v2.5.2 

func (v *Viper) AllowEmptyEnv(allowEmptyEnv bool)

func (*Viper) AutomaticEnv added in v2.5.2 

func (v *Viper) AutomaticEnv()

func (*Viper) BindEnv added in v2.5.2 

func (v *Viper) BindEnv(input ...string) error

func (*Viper) BindFlagValue added in v2.5.2 

func (v *Viper) BindFlagValue(key string, flag FlagValue) error

func (*Viper) BindFlagValues added in v2.5.2 

func (v *Viper) BindFlagValues(flags FlagValueSet) (err error)

func (*Viper) BindPFlag added in v2.5.2 

func (v *Viper) BindPFlag(key string, flag *pflag.Flag) error

func (*Viper) BindPFlags added in v2.5.2 

func (v *Viper) BindPFlags(flags *pflag.FlagSet) error

func (*Viper) Bool added in v2.5.2 

func (v *Viper) Bool(key string, defVal ...bool) (value bool)

func (*Viper) ConfigFileUsed added in v2.5.2 

func (v *Viper) ConfigFileUsed() string

func (*Viper) Debug added in v2.5.2 

func (v *Viper) Debug()

func (*Viper) Float added in v2.5.2 

func (v *Viper) Float(key string, defVal ...float64) (value float64)

func (*Viper) Get added in v2.5.2 

func (v *Viper) Get(key string) interface{}

func (*Viper) GetBool added in v2.5.2 

func (v *Viper) GetBool(key string) bool

func (*Viper) GetDuration added in v2.5.2 

func (v *Viper) GetDuration(key string) time.Duration

func (*Viper) GetFloat64 added in v2.5.2 

func (v *Viper) GetFloat64(key string) float64

func (*Viper) GetInt added in v2.5.2 

func (v *Viper) GetInt(key string) int

func (*Viper) GetInt32 added in v2.5.2 

func (v *Viper) GetInt32(key string) int32

func (*Viper) GetInt64 added in v2.5.2 

func (v *Viper) GetInt64(key string) int64

func (*Viper) GetIntSlice added in v2.5.2 

func (v *Viper) GetIntSlice(key string) []int

func (*Viper) GetSizeInBytes added in v2.5.2 

func (v *Viper) GetSizeInBytes(key string) uint

func (*Viper) GetString added in v2.5.2 

func (v *Viper) GetString(key string) string

func (*Viper) GetStringMap added in v2.5.2 

func (v *Viper) GetStringMap(key string) map[string]interface{}

func (*Viper) GetStringMapString added in v2.5.2 

func (v *Viper) GetStringMapString(key string) map[string]string

func (*Viper) GetStringMapStringSlice added in v2.5.2 

func (v *Viper) GetStringMapStringSlice(key string) map[string][]string

func (*Viper) GetStringSlice added in v2.5.2 

func (v *Viper) GetStringSlice(key string) []string

func (*Viper) GetTime added in v2.5.2 

func (v *Viper) GetTime(key string) time.Time

func (*Viper) GetUint added in v2.5.2 

func (v *Viper) GetUint(key string) uint

func (*Viper) GetUint32 added in v2.5.2 

func (v *Viper) GetUint32(key string) uint32

func (*Viper) GetUint64 added in v2.5.2 

func (v *Viper) GetUint64(key string) uint64

func (*Viper) InConfig added in v2.5.2 

func (v *Viper) InConfig(key string) bool

func (*Viper) Int added in v2.5.2 

func (v *Viper) Int(key string, defVal ...int) (value int)

func (*Viper) Int64 added in v2.5.2 

func (v *Viper) Int64(key string, defVal ...int64) (value int64)

func (*Viper) IntMap added in v2.6.3 

func (v *Viper) IntMap(key string) map[string]int

func (*Viper) Ints added in v2.5.2 

func (v *Viper) Ints(key string) []int

func (*Viper) IsSet added in v2.5.2 

func (v *Viper) IsSet(key string) bool

func (*Viper) MergeConfig added in v2.5.2 

func (v *Viper) MergeConfig(in io.Reader) error

func (*Viper) MergeConfigMap added in v2.5.2 

func (v *Viper) MergeConfigMap(cfg map[string]interface{}) error

func (*Viper) MergeInConfig added in v2.5.2 

func (v *Viper) MergeInConfig() error

func (*Viper) OnConfigChange added in v2.5.2 

func (v *Viper) OnConfigChange(run func(in fsnotify.Event))

func (*Viper) ReadConfig added in v2.5.2 

func (v *Viper) ReadConfig(in io.Reader) error

func (*Viper) ReadInConfig added in v2.5.2 

func (v *Viper) ReadInConfig() error

func (*Viper) ReadRemoteConfig added in v2.5.2 

func (v *Viper) ReadRemoteConfig() error

func (*Viper) RegisterAlias added in v2.5.2 

func (v *Viper) RegisterAlias(alias string, key string)

func (*Viper) SafeWriteConfig added in v2.5.2 

func (v *Viper) SafeWriteConfig() error

func (*Viper) SafeWriteConfigAs added in v2.5.2 

func (v *Viper) SafeWriteConfigAs(filename string) error

func (*Viper) Set added in v2.5.2 

func (v *Viper) Set(key string, value interface{})

func (*Viper) SetConfigFile added in v2.5.2 

func (v *Viper) SetConfigFile(in string)

func (*Viper) SetConfigName added in v2.5.2 

func (v *Viper) SetConfigName(in string)

func (*Viper) SetConfigPermissions added in v2.5.2 

func (v *Viper) SetConfigPermissions(perm os.FileMode)

func (*Viper) SetConfigType added in v2.5.2 

func (v *Viper) SetConfigType(in string)

func (*Viper) SetDefault added in v2.5.2 

func (v *Viper) SetDefault(key string, value interface{})

func (*Viper) SetEnvKeyReplacer added in v2.5.2 

func (v *Viper) SetEnvKeyReplacer(r *strings.Replacer)

func (*Viper) SetEnvPrefix added in v2.5.2 

func (v *Viper) SetEnvPrefix(in string)

func (*Viper) SetFs added in v2.5.2 

func (v *Viper) SetFs(fs afero.Fs)

func (*Viper) SetTypeByDefaultValue added in v2.5.2 

func (v *Viper) SetTypeByDefaultValue(enable bool)

func (*Viper) String added in v2.5.2 

func (v *Viper) String(key string, defVal ...string) (value string)

func (*Viper) StringMap added in v2.5.2 

func (v *Viper) StringMap(key string) map[string]string

func (*Viper) Strings added in v2.5.2 

func (v *Viper) Strings(key string) []string

func (*Viper) Sub added in v2.5.2 

func (v *Viper) Sub(key string) *Viper

func (*Viper) Uint added in v2.5.2 

func (v *Viper) Uint(key string, defVal ...uint) (value uint)

func (*Viper) Unmarshal added in v2.5.2 

func (v *Viper) Unmarshal(rawVal interface{}, opts ...DecoderConfigOption) error

func (*Viper) UnmarshalExact added in v2.5.2 

func (v *Viper) UnmarshalExact(rawVal interface{}, opts ...DecoderConfigOption) error

func (*Viper) UnmarshalKey added in v2.5.2 

func (v *Viper) UnmarshalKey(key string, rawVal interface{}, opts ...DecoderConfigOption) error

func (*Viper) WatchConfig added in v2.5.2 

func (v *Viper) WatchConfig()

func (*Viper) WatchRemoteConfig added in v2.5.2 

func (v *Viper) WatchRemoteConfig() error

func (*Viper) WatchRemoteConfigOnChannel added in v2.5.2 

func (v *Viper) WatchRemoteConfigOnChannel() error

func (*Viper) WriteConfig added in v2.5.2 

func (v *Viper) WriteConfig() error

func (*Viper) WriteConfigAs added in v2.5.2 

func (v *Viper) WriteConfigAs(filename string) error

Source Files

View all Source files

Directories

Path Synopsis
internal
encoding
encoding/dotenv
encoding/hcl
encoding/ini
encoding/javaproperties
encoding/json
encoding/toml
encoding/yaml
parser
ini
ini/parser
Package remote integrates the remote features of Viper.
 Package remote integrates the remote features of Viper.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.