conf

README

Json config library

Библиотека позволяет удобно пользоваться конфигурационными файлами, написанными в формате JSON

To do:

• Описания функций
• Примеры
• Больше тестов

Documentation

Overview

Package conf позволяет удобно пользоваться конфигурационными файлами, написанными в формате JSON

Index

• func CheckJson(data []byte, appName string) bool
• func FirstFloat32(keysList ...[]string) (float32, bool)
• func FirstFloat64(keysList ...[]string) (float64, bool)
• func FirstInt(keysList ...[]string) (int, bool)
• func FirstInt32(keysList ...[]string) (int32, bool)
• func FirstInt64(keysList ...[]string) (int64, bool)
• func FirstInt8(keysList ...[]string) (int8, bool)
• func FirstString(keysList ...[]string) (string, bool)
• func FirstStringArray(keysList ...[]string) ([]string, bool)
• func FirstUint32(keysList ...[]string) (uint32, bool)
• func FirstUint64(keysList ...[]string) (uint64, bool)
• func Float32(keys ...string) (float32, bool)
• func Float64(keys ...string) (float64, bool)
• func Get(keys ...string) ([]byte, bool)
• func Init(applicationName string)
• func Int(keys ...string) (int, bool)
• func Int32(keys ...string) (int32, bool)
• func Int64(keys ...string) (int64, bool)
• func Int8(keys ...string) (int8, bool)
• func SetConfig(config []byte, name string) error
• func SetConfigFromFile(fileName, name string) error
• func String(keys ...string) (string, bool)
• func StringArray(keys ...string) ([]string, bool)
• func StringMap(keys ...string) (map[string]string, bool)
• func Uint32(keys ...string) (uint32, bool)
• func Uint64(keys ...string) (uint64, bool)

Functions

func CheckJson

func CheckJson(data []byte, appName string) bool

CheckJson проверяет валидность конфига Каждый конфиг должен иметь поле "app": appName для проверки json, и чтобы нельзя было случайно подсунуть другой json

func FirstFloat32

func FirstFloat32(keysList ...[]string) (float32, bool)

FirstFloat32 возвращает первое найденное число из конфига по списку наборов ключей

func FirstFloat64

func FirstFloat64(keysList ...[]string) (float64, bool)

FirstFloat64 возвращает первое найденное число из конфига по списку наборов ключей

func FirstInt

func FirstInt(keysList ...[]string) (int, bool)

FirstInt возвращает первое найденное число из конфига по списку наборов ключей

func FirstInt32

func FirstInt32(keysList ...[]string) (int32, bool)

FirstInt32 возвращает первое найденное число из конфига по списку наборов ключей

func FirstInt64

func FirstInt64(keysList ...[]string) (int64, bool)

FirstInt64 возвращает первое найденное число из конфига по списку наборов ключей

func FirstInt8

func FirstInt8(keysList ...[]string) (int8, bool)

FirstInt8 возвращает первое найденное число из конфига по списку наборов ключей

func FirstString

func FirstString(keysList ...[]string) (string, bool)

FirstString для списка наборов ключей возвращает первое значение найденное в конфиге Функции с префиксом First- придуманы для удобства имплементации дефолтных значений

func FirstStringArray

func FirstStringArray(keysList ...[]string) ([]string, bool)

StringArray возвращает первый найденный в конфиге массив строк по набору ключей

func FirstUint32

func FirstUint32(keysList ...[]string) (uint32, bool)

FirstUint32 возвращает первое найденное число из конфига по списку наборов ключей

func FirstUint64

func FirstUint64(keysList ...[]string) (uint64, bool)

FirstUint64 возвращает первое найденное число из конфига по списку наборов ключей

func Float32

func Float32(keys ...string) (float32, bool)

Float32 возвращает число из конфига по набору ключей

func Float64

func Float64(keys ...string) (float64, bool)

Float64 возвращает число из конфига по набору ключей

func Get

func Get(keys ...string) ([]byte, bool)

Get по списку ключей возвращает слайс байтов с требуемым куском JSON

func Init

func Init(applicationName string)

Init должен быть первым вызовом библиоткеи в приложении, applicationName должен соответствовать полю "app": appName в используемых конфигах

func Int

func Int(keys ...string) (int, bool)

Int возвращает число из конфига по набору ключей

func Int32

func Int32(keys ...string) (int32, bool)

Int32 возвращает число из конфига по набору ключей

func Int64

func Int64(keys ...string) (int64, bool)

Int64 возвращает число из конфига по набору ключей

func Int8

func Int8(keys ...string) (int8, bool)

Int8 возвращает число из конфига по набору ключей

func SetConfig

func SetConfig(config []byte, name string) error

SetConfig добавляет в библиотеку новый конфиг или перезаписывает существующий Конфиги будут применяться в порядке возрастания имени ключа. Ex: 01-file, 02-add, 99-default

func SetConfigFromFile

func SetConfigFromFile(fileName, name string) error

SetConfigFromFile добавляет в библиотеку новый или перезаписывает существующий конфиг из файла

func String

func String(keys ...string) (string, bool)

String возвращает строку из конфига по набору ключей

func StringArray

func StringArray(keys ...string) ([]string, bool)

StringArray возвращает массив строк из конфига по набору ключей

func StringMap

func StringMap(keys ...string) (map[string]string, bool)

StringMap возвращает словарь строк по набору ключей

func Uint32

func Uint32(keys ...string) (uint32, bool)

Uint32 возвращает число из конфига по набору ключей

func Uint64

func Uint64(keys ...string) (uint64, bool)

Uint64 возвращает число из конфига по набору ключей