fabric: github.com/hyperledger/fabric/vendor/github.com/spf13/viper Index | Files

package viper

import "github.com/hyperledger/fabric/vendor/github.com/spf13/viper"

Index

Package Files

util.go viper.go

Variables

var RemoteConfig remoteConfigFactory

RemoteConfig is optional, see the remote package

var SupportedExts []string = []string{"json", "toml", "yaml", "yml", "properties", "props", "prop"}

Universally supported extensions.

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

Universally supported remote providers.

func AddConfigPath Uses

func AddConfigPath(in string)

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

func AddRemoteProvider Uses

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" or "consul" 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 Uses

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" or "consul" 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/xordataexchange/crypt

func AllKeys Uses

func AllKeys() []string

Return all keys regardless where they are set

func AllSettings Uses

func AllSettings() map[string]interface{}

Return all settings as a map[string]interface{}

func AutomaticEnv Uses

func AutomaticEnv()

Have Viper check ENV variables for all keys set in config, default & flags

func BindEnv Uses

func BindEnv(input ...string) (err error)

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.

func BindPFlag Uses

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

Bind a specific key to a flag (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 Uses

func BindPFlags(flags *pflag.FlagSet) (err error)

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

func ConfigFileUsed Uses

func ConfigFileUsed() string

Return the file used to populate the config registry

func Debug Uses

func Debug()

Prints all configuration registries for debugging purposes.

func Get Uses

func Get(key string) interface{}

Viper is essentially repository for configurations Get can retrieve any value given the key to use 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 Uses

func GetBool(key string) bool

Returns the value associated with the key asa boolean

func GetDuration Uses

func GetDuration(key string) time.Duration

Returns the value associated with the key as a duration

func GetFloat64 Uses

func GetFloat64(key string) float64

Returns the value associated with the key as a float64

func GetInt Uses

func GetInt(key string) int

Returns the value associated with the key as an integer

func GetSizeInBytes Uses

func GetSizeInBytes(key string) uint

Returns the size of the value associated with the given key in bytes.

func GetString Uses

func GetString(key string) string

Returns the value associated with the key as a string

func GetStringMap Uses

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

Returns the value associated with the key as a map of interfaces

func GetStringMapString Uses

func GetStringMapString(key string) map[string]string

Returns the value associated with the key as a map of strings

func GetStringMapStringSlice Uses

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

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

func GetStringSlice Uses

func GetStringSlice(key string) []string

Returns the value associated with the key as a slice of strings

func GetTime Uses

func GetTime(key string) time.Time

Returns the value associated with the key as time

func InConfig Uses

func InConfig(key string) bool

Check to see if the given key (or an alias) is in the config file

func IsSet Uses

func IsSet(key string) bool

Check to see if the key has been set in any of the data locations

func ReadConfig Uses

func ReadConfig(in io.Reader) error

func ReadInConfig Uses

func ReadInConfig() error

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

func ReadRemoteConfig Uses

func ReadRemoteConfig() error

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

func RegisterAlias Uses

func RegisterAlias(alias string, key string)

Aliases provide another accessor for the same key. This enables one to change a name without breaking the application

func Reset Uses

func Reset()

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 Set Uses

func Set(key string, value interface{})

Sets the value for the key in the override regiser. Will be used instead of values obtained via flags, config file, ENV, default, or key/value store

func SetConfigFile Uses

func SetConfigFile(in string)

Explicitly define the path, name and extension of the config file Viper will use this and not check any of the config paths

func SetConfigName Uses

func SetConfigName(in string)

Name for the config file. Does not include extension.

func SetConfigType Uses

func SetConfigType(in string)

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

func SetDefault Uses

func SetDefault(key string, value interface{})

Set the default value for this key. Default only used when no value is provided by the user via flag, config or ENV.

func SetEnvKeyReplacer Uses

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 Uses

func SetEnvPrefix(in string)

Define 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 SetTypeByDefaultValue Uses

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 Unmarshal Uses

func Unmarshal(rawVal interface{}) error

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

func UnmarshalKey Uses

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

Takes a single key and unmarshals it into a Struct

func WatchRemoteConfig Uses

func WatchRemoteConfig() error

type ConfigFileNotFoundError Uses

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

Denotes failing to find configuration file.

func (ConfigFileNotFoundError) Error Uses

func (fnfe ConfigFileNotFoundError) Error() string

Returns the formatted configuration error.

type ConfigParseError Uses

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

Denotes failing to parse configuration file.

func (ConfigParseError) Error Uses

func (pe ConfigParseError) Error() string

Returns the formatted configuration error.

type RemoteConfigError Uses

type RemoteConfigError string

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

func (RemoteConfigError) Error Uses

func (rce RemoteConfigError) Error() string

Returns the formatted remote provider error

type RemoteProvider Uses

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 UnsupportedConfigError Uses

type UnsupportedConfigError string

Denotes encountering an unsupported configuration filetype.

func (UnsupportedConfigError) Error Uses

func (str UnsupportedConfigError) Error() string

Returns the formatted configuration error.

type UnsupportedRemoteProviderError Uses

type UnsupportedRemoteProviderError string

Denotes encountering an unsupported remote provider. Currently only Etcd and Consul are supported.

func (UnsupportedRemoteProviderError) Error Uses

func (str UnsupportedRemoteProviderError) Error() string

Returns the formatted remote provider error.

type Viper Uses

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

func New Uses

func New() *Viper

Returns an initialized Viper instance.

func (*Viper) AddConfigPath Uses

func (v *Viper) AddConfigPath(in string)

func (*Viper) AddRemoteProvider Uses

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

func (*Viper) AddSecureRemoteProvider Uses

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

func (*Viper) AllKeys Uses

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

func (*Viper) AllSettings Uses

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

func (*Viper) AutomaticEnv Uses

func (v *Viper) AutomaticEnv()

func (*Viper) BindEnv Uses

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

func (*Viper) BindPFlag Uses

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

func (*Viper) BindPFlags Uses

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

func (*Viper) ConfigFileUsed Uses

func (v *Viper) ConfigFileUsed() string

func (*Viper) Debug Uses

func (v *Viper) Debug()

func (*Viper) Get Uses

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

func (*Viper) GetBool Uses

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

func (*Viper) GetDuration Uses

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

func (*Viper) GetFloat64 Uses

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

func (*Viper) GetInt Uses

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

func (*Viper) GetSizeInBytes Uses

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

func (*Viper) GetString Uses

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

func (*Viper) GetStringMap Uses

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

func (*Viper) GetStringMapString Uses

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

func (*Viper) GetStringMapStringSlice Uses

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

func (*Viper) GetStringSlice Uses

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

func (*Viper) GetTime Uses

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

func (*Viper) InConfig Uses

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

func (*Viper) IsSet Uses

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

func (*Viper) ReadConfig Uses

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

func (*Viper) ReadInConfig Uses

func (v *Viper) ReadInConfig() error

func (*Viper) ReadRemoteConfig Uses

func (v *Viper) ReadRemoteConfig() error

func (*Viper) RegisterAlias Uses

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

func (*Viper) Set Uses

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

func (*Viper) SetConfigFile Uses

func (v *Viper) SetConfigFile(in string)

func (*Viper) SetConfigName Uses

func (v *Viper) SetConfigName(in string)

func (*Viper) SetConfigType Uses

func (v *Viper) SetConfigType(in string)

func (*Viper) SetDefault Uses

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

func (*Viper) SetEnvKeyReplacer Uses

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

func (*Viper) SetEnvPrefix Uses

func (v *Viper) SetEnvPrefix(in string)

func (*Viper) SetTypeByDefaultValue Uses

func (v *Viper) SetTypeByDefaultValue(enable bool)

func (*Viper) Unmarshal Uses

func (v *Viper) Unmarshal(rawVal interface{}) error

func (*Viper) UnmarshalKey Uses

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

func (*Viper) WatchRemoteConfig Uses

func (v *Viper) WatchRemoteConfig() error

Package viper imports 20 packages (graph). Updated 2018-07-07. Refresh now. Tools for package owners.