conf

Documentation

Index

• 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
  • func UseEnv() Option
• type Properties
  • func LoadProperties(filename string, opts ...Option) (Properties, error)
  • func NewProperties() Properties
• type PropertyError
  • func (configError *PropertyError) Error() string

Functions

func LoadConfig

func LoadConfig(file string, v interface{}, opts ...Option) error

func LoadConfigFromJsonBytes

func LoadConfigFromJsonBytes(content []byte, v interface{}) error

func LoadConfigFromYamlBytes

func LoadConfigFromYamlBytes(content []byte, v interface{}) error

func MustLoad

func MustLoad(path string, v interface{}, opts ...Option)

Types

type Option

type Option func(opt *options)

func UseEnv

func UseEnv() Option

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)

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

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

Returns the error message.