Documentation
¶
Index ¶
- func CheckedDuration(duration time.Duration) time.Duration
- func LoadConfig(file string, v interface{}, opts ...Option) error
- func LoadConfigFromJsonBytes(content []byte, v interface{}) error
- func LoadConfigFromYamlBytes(content []byte, v interface{}) error
- func MustLoad(path string, v interface{}, opts ...Option)
- type Option
- type Properties
- type PropertyError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckedDuration ¶ added in v1.2.3
CheckedDuration returns the duration that guaranteed to be greater than 100us. Why we need this is because users sometimes intend to use 500 to represent 500ms. In config, duration less than 100us should always be missing ms etc.
func LoadConfig ¶
LoadConfig loads config into v from file, .json, .yaml and .yml are acceptable.
func LoadConfigFromJsonBytes ¶
LoadConfigFromJsonBytes loads config into v from content json bytes.
func LoadConfigFromYamlBytes ¶
LoadConfigFromYamlBytes loads config into v from content yaml bytes.
Types ¶
type Option ¶ added in v1.1.5
type Option func(opt *options)
Option defines the method to customize the config options.
type Properties ¶
type Properties interface {
GetString(key string) string
SetString(key, value string)
GetInt(key string) int
SetInt(key string, value int)
ToString() string
}
Properties interface provides the means to access configuration.
func LoadProperties ¶
func LoadProperties(filename string, opts ...Option) (Properties, error)
LoadProperties loads the properties into a properties configuration instance. Returns an error that indicates if there was a problem loading the configuration.
func NewProperties ¶
func NewProperties() Properties
NewProperties builds a new properties configuration structure.
type PropertyError ¶
type PropertyError struct {
// contains filtered or unexported fields
}
PropertyError represents a configuration error message.
func (*PropertyError) Error ¶
func (configError *PropertyError) Error() string
Error returns the error message.
Source Files