configr

package module

Go to main page

Versions in this module

v0

v0.6.0

Apr 5, 2020

Changes in this version

+ func RegisterFromStruct(structPtr interface{}, fieldToKeyFunc ...NameToKeyFunc) error

+ func ToLowerCamelCase(s string) string

+ func UnmarshalKey(key string, destination interface{}) error

type Config

+ Unmarshal func(interface{}) error

+ UnmarshalKey func(string, interface{}) error

type Configr

+ func (c *Configr) RegisterFromStruct(structPtr interface{}, fieldToKeyFunc ...NameToKeyFunc) error

+ func (c *Configr) Unmarshal(destination interface{}) error

+ func (c *Configr) UnmarshalKey(key string, destination interface{}) error

+ type InvalidTypeError struct

+ Type reflect.Type

+ func (e InvalidTypeError) Error() string

type Manager

+ RegisterFromStruct func(interface{}, ...NameToKeyFunc) error

+ type NameToKeyFunc func(string) string

v0.5.1

Nov 25, 2016

v0.5.0

Nov 3, 2016

Changes in this version

type KeySplitter

+ func NewKeySplitter(delimeter string) KeySplitter

+ type ValidationError struct

+ Err error

+ Key string

+ func NewValidationError(key string, err error) ValidationError

+ func (v ValidationError) Error() string

v0.4.0

Jun 24, 2016

Changes in this version

+ const EnvVarSeparator

+ type EnvVars struct

+ func NewEnvVars(prefix string) *EnvVars

+ func (e *EnvVars) KeysToUnmarshal(keys []string, keySplitter KeySplitter)

+ func (e *EnvVars) Unmarshal() (map[string]interface{}, error)

type File

+ func (f *File) KeysToUnmarshal(_ []string, _ KeySplitter)

+ type KeySplitter func(string) []string

type Source

+ KeysToUnmarshal func([]string, KeySplitter)

v0.3.0

Jan 23, 2016

Changes in this version

+ var ExtensionToDecoderName = make(map[string]string)

+ var ExtensionToEncoderName = make(map[string]string)

+ var RegisteredFileDecoders = make(map[string]FileDecoder)

+ var RegisteredFileEncoders = make(map[string]Encoder)

+ func RegisterFileDecoder(name string, source FileDecoder, fileExtensions ...string)

+ func RegisterFileEncoder(name string, encoder Encoder, fileExtensions ...string)

+ type File struct

+ func NewFile(path string) *File

+ func (f *File) Marshal(v interface{}) ([]byte, error)

+ func (f *File) Path() string

+ func (f *File) SetEncodingName(name string)

+ func (f *File) SetPath(path string)

+ func (f *File) Unmarshal() (map[string]interface{}, error)

+ type FileDecoder interface

+ Unmarshal func([]byte, interface{}) error

+ type FileDecoderAdapter func([]byte, interface{}) error

+ func (f FileDecoderAdapter) Unmarshal(b []byte, v interface{}) error

v0.2.0

Jan 1, 2016

Changes in this version

type Configr

+ func (c *Configr) Read(key string) (interface{}, error)

+ type EncoderAdapter func(interface{}) ([]byte, error)

+ func (f EncoderAdapter) Marshal(v interface{}) ([]byte, error)

v0.1.1

Sep 25, 2015

v0.1.0

Sep 25, 2015

Changes in this version

+ var ErrKeyNotFound = errors.New("configr: Key not found")

+ var ErrNoRegisteredValues = errors.New("configr: No registered values to generate")

+ var ErrParseHasntBeenCalled = errors.New("configr: Trying to get values before calling Parse()")

+ var ErrUnknownEncoding = errors.New("configr: Unable to determine file encoding, please set manually")

+ var SupportedFileExtensions = []string

+ func AddSource(p Source)

+ func Bool(key string) (bool, error)

+ func FilePath() string

+ func Float64(key string) (float64, error)

+ func GenerateBlank(e Encoder) ([]byte, error)

+ func Get(key string) (interface{}, error)

+ func Int(key string) (int, error)

+ func Marshal(v interface{}) ([]byte, error)

+ func MustParse()

+ func Parse() error

+ func Parsed() bool

+ func RegisterKey(name, description string, defaultVal interface{}, validators ...Validator)

+ func RequireKey(name, description string, validators ...Validator)

+ func SetConfigr(c *Configr)

+ func SetEncoding(encoding Encoding)

+ func SetFilePath(path string)

+ func String(key string) (string, error)

+ func Unmarshal() (map[string]interface{}, error)

+ type Config interface

+ Bool func(string) (bool, error)

+ Float64 func(string) (float64, error)

+ Get func(string) (interface{}, error)

+ Int func(string) (int, error)

+ MustParse func()

+ Parse func() error

+ Parsed func() bool

+ String func(string) (string, error)

+ type Configr struct

+ func GetConfigr() *Configr

+ func New() *Configr

+ func (c *Configr) AddSource(p Source)

+ func (c *Configr) Bool(key string) (bool, error)

+ func (c *Configr) Float64(key string) (float64, error)

+ func (c *Configr) GenerateBlank(e Encoder) ([]byte, error)

+ func (c *Configr) Get(key string) (interface{}, error)

+ func (c *Configr) Int(key string) (int, error)

+ func (c *Configr) MustParse()

+ func (c *Configr) Parse() error

+ func (c *Configr) Parsed() bool

+ func (c *Configr) RegisterKey(name, description string, defaultVal interface{}, validators ...Validator)

+ func (c *Configr) RequireKey(name, description string, validators ...Validator)

+ func (c *Configr) SetDescriptionWrapper(wrapper string)

+ func (c *Configr) SetIsCaseSensitive(isCaseSensitive bool)

+ func (c *Configr) SetKeyPathDelimeter(delimeter string)

+ func (c *Configr) String(key string) (string, error)

+ type Encoder interface

+ Marshal func(interface{}) ([]byte, error)

+ type Encoding int

+ const JSON

+ const TOML

+ const Unknown

+ type ErrRequiredKeysMissing []string

+ func (e ErrRequiredKeysMissing) Error() string

+ type FileSource struct

+ func NewFileSource(filePath string) *FileSource

+ func (f *FileSource) FilePath() string

+ func (f *FileSource) Marshal(v interface{}) ([]byte, error)

+ func (f *FileSource) SetEncoding(encoding Encoding)

+ func (f *FileSource) SetFilePath(path string)

+ func (f *FileSource) Unmarshal() (map[string]interface{}, error)

+ type Manager interface

+ AddSource func(Source)

+ GenerateBlank func(Encoder) ([]byte, error)

+ RegisterKey func(string, string, interface{}, ...Validator)

+ RequireKey func(string, string, ...Validator)

+ SetIsCaseSensitive func(bool)

+ type Source interface

+ Unmarshal func() (map[string]interface{}, error)

+ type SourceAdapter func() (map[string]interface{}, error)

+ func (f SourceAdapter) Unmarshal() (map[string]interface{}, error)

+ type Validator func(interface{}) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL