config

Documentation

Overview

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• Variables
• func FromConfigFile(filePath string, defaults []Default, configValidators ...Validator) error
• func SetDefaults(c Writer, defaults []Default)
• func ValidateConfig(c Reader, validators ...Validator) error
• type Default
• type Handler
• type Reader
• type Validator
• type Writer

Variables

var (
	Config = viper.New()
)

Functions

func FromConfigFile

func FromConfigFile(filePath string,
	defaults []Default,
	configValidators ...Validator) error

func SetDefaults

func SetDefaults(c Writer, defaults []Default)

func ValidateConfig

func ValidateConfig(c Reader, validators ...Validator) error

ValidateConfig validates conifg accroding to provided validators.

Types

type Default

type Default struct {
	Key   string
	Value interface{}
}

type Handler

type Handler interface {
	Reader
	Writer
}

type Reader

type Reader interface {
	Get(key string) interface{}
	GetBool(key string) bool
	GetFloat64(key string) float64
	GetInt(key string) int
	GetString(key string) string
	GetStringMap(key string) map[string]interface{}
	GetStringMapString(key string) map[string]string
	GetStringSlice(key string) []string
	GetTime(key string) time.Time
	GetDuration(key string) time.Duration
	IsSet(key string) bool
}

type Validator

type Validator func(c Reader) error

type Writer

type Writer interface {
	SetDefault(key string, val interface{})
	Set(key string, val interface{})
}