cfg

type Err interface {
	Anchor() error // Якорь, по которому можно сравнивать две ошибки между собой.
	Code() uint8   // Код ошибки.
	Error() string // Сообщение об ошибке или шаблон сообщения об ошибке.
}

type Error struct{}

type Essence interface {

	// Cfg Интерфейс конфигурации.
	Cfg() Interface

	// Logger Интерфейс менеджера логирования.
	Logger() kitModuleLog.Logger

	// CLI Интерфейс к методам работы с параметрами командной строки и переменных окружения.
	CLI() kitModuleCfgCli.Interface

	// App Точка запуска приложения.
	App()

	// AppName Установка значения названия приложения.
	AppName(name string) Essence

	// Version Присвоение версии и номера сборки приложения в семантике "Semantic Versioning 2.0.0".
	Version(version string, build string) Essence

	// Debug Присвоение нового значения режима отладки приложения.
	Debug(debug bool) Essence

	// UpdateBootstrapConfigurationPathValue Коррекция значений стартовой конфигурация приложения, если они были загружены
	// из командной строки или переменной окружения, то есть не равны значениям по умолчанию
	UpdateBootstrapConfigurationPathValue() Essence

	// CommandFull Присвоение значения команды с которой было запущено приложение.
	CommandFull(cmd []string) Essence

	// ForkWorkerMode Присвоение нового значения режима запуска в качестве подчинённого процесса основного приложения.
	ForkWorkerMode(isForkWorker bool) Essence

	// ErrorAppend Добавление ошибки в стек ошибок приложения.
	ErrorAppend(err error) Essence

	// IsError Возвращает истину, если есть ошибки приложения.
	IsError() bool

	// Runlevel Установка или увеличение значения уровня работы приложения.
	// Поведение функции в зависимости от значения аргумента runlevel:
	// * runlevel>0 - будет выполнена установка нового значения, новое значение не может быть меньше текущего значения.
	// * runlevel=0 - значение Runlevel будет увеличено на единицу.
	Runlevel(runlevel uint16) Essence

	// RunlevelNext Переключение значения уровня работы приложения на следующий уровень.
	// От 01 до 10 переключается на единицу, последовательно.
	// От 10 до 65535 переключается согласно карте уровней, если текущий уровень не входит в карту - последовательно.
	// На уровне 65535 переключение останавливается, вызов функции не меняет уровень.
	RunlevelNext() Essence

	// RunlevelNextAsync Асинхронное переключение значения уровня работы приложения на следующий уровень.
	RunlevelNextAsync()

	// RunlevelDefault Уровень выполнения компонентов приложения по умолчанию.
	RunlevelDefault() (ret uint16)

	// RunlevelAutoincrementStop Отключение режима автоматического увеличения уровня работы приложения.
	RunlevelAutoincrementStop() Essence

	// RunlevelAutoincrementStart Включение режима автоматического увеличения уровня работы приложения.
	RunlevelAutoincrementStart() Essence

	// RunlevelExit Переключение значения уровня работы приложения на уровень завершения работы приложения.
	RunlevelExit() Essence

	// RunlevelExitAsync Переключение значения уровня работы приложения на уровень завершения работы приложения.
	RunlevelExitAsync()

	// Targetlevel Установка значения целевого уровня работы приложения.
	Targetlevel(tl uint16) Essence

	// Registration Регистрация разных объектов приложения.
	Registration(name string, obj any) (err error)

	// ComponentName Получение уникального имени пакета компоненты.
	ComponentName(obj any) (ret string)

	// ComponentNames Возвращает список зарегистрированных компонентов.
	ComponentNames() []string

	// ComponentPreferences Функция-менеджер загрузки и обработки настроек компонентов.
	ComponentPreferences(fn kitTypes.ComponentPreferencesFn) (code uint8, err error)

	// ComponentCheckConflict Проверка конфликтов между всеми зарегистрированными компонентами.
	ComponentCheckConflict(fn kitTypes.ComponentConflictFn) (code uint8, err error)

	// ComponentRequiresCheck Проверка зависимостей между всеми зарегистрированными компонентами.
	ComponentRequiresCheck(fn kitTypes.ComponentRequiresFn) (code uint8, err error)

	// ComponentSort Сортировка зарегистрированных компонентов в соответствии с настройками (before) и (after).
	ComponentSort(fn kitTypes.ComponentSortFn) (code uint8, err error)

	// ComponentMapRunlevel Построение шагов переключения уровня выполнения приложения (runlevel).
	ComponentMapRunlevel(targetlevel uint16) (code uint8, err error)

	// ComponentInitiate Вызов функции Initiate у всех зарегистрированных компонентов в прямом порядке.
	ComponentInitiate(fn kitTypes.ComponentInitiateFn) (code uint8, err error)

	// ComponentDo Вызов функции Do у всех зарегистрированных компонентов в прямом порядке для указанного уровня приложения.
	ComponentDo(runlevel uint16, fn kitTypes.ComponentDoFn) (code uint8, err error)

	// ComponentFinalizeWarningTimeout Возвращает время отводимое на выполнение функции Finalize(), до печати в лог
	// сообщения о долгой работе функции.
	ComponentFinalizeWarningTimeout() (ret time.Duration)

	// ComponentFinalize Вызов функции Finalize у всех зарегистрированных компонентов в обратном порядке.
	ComponentFinalize(fn kitTypes.ComponentFinalizeFn) (code uint8, err error)

	// ComponentCommandRegister Регистрация команды и группы команд компоненты.
	ComponentCommandRegister(cc kitTypes.ComponentCommand)

	// ComponentFlagRegister Регистрация глобального флага компоненты приложения.
	ComponentFlagRegister(cf kitTypes.ComponentFlag)

	// DirectoryHome Установка значения домашней директория приложения.
	DirectoryHome(ahd string) Essence

	// DirectoryWorking Установка значения рабочей директории приложения.
	DirectoryWorking(awd string) Essence

	// DirectoryTemp Установка значения директории для временных файлов.
	DirectoryTemp(atd string) Essence

	// DirectoryCache Установка значения директории для файлов кеша.
	DirectoryCache(acd string) Essence

	// DirectoryConfig Установка значения директории для подключаемых или дополнительных конфигураций приложения.
	DirectoryConfig(afd string) Essence

	// FileConfig Установка значения пути и имени конфигурационного файла приложения.
	FileConfig(cfn string) Essence

	// FilePid Установка значения пути и имени PID файла приложения.
	FilePid(pfn string) Essence

	// FileState Установка значения пути и имени файла хранения состояния приложения.
	FileState(stf string) Essence

	// FileSocket Установка значения пути и имени сокет файла коммуникаций с приложением.
	FileSocket(sof string) Essence

	// LogLevel Установка значения уровня логирования приложения.
	LogLevel(ll kitModuleLogLevel.Level) Essence

	// ConfigurationRegistration Регистрация объекта конфигурации, являющегося частью общей конфигурации приложения.
	// Регистрация доступна только на уровне работы приложения 0.
	// Объект конфигурации должен передаваться в качестве адреса.
	// Поля объекта конфигурации должны состоять из простых и/или сериализуемых типов данных и быть экспортируемыми.
	// Поля объекта могут содержать теги, которые определяют внедрение конфигурации в конфигурацию приложения.
	// Вместе с объектом конфигурации можно передать функцию обратного вызова, она будет вызвана при изменении данных
	// конфигурации, например при перезагрузке файла конфигурации или иных реализациях динамического изменения
	// значений конфигурации.
	// Теги:
	//   - description ---- Описание поля, публикуется в YAML файле, при создании примера конфигурации,
	//     подробности в компоненте "configuration".
	//     Если указано значение "-", тогда описание не публикуется.
	//   - default-value -- Значение поля по умолчанию, присваивается после чтения конфигурационного файла,
	//     а так же, публикуется в YAML файле, при создании примера конфигурации.
	//   - yaml ----------- Тег для библиотеки YAML, если указано значение "-", тогда поле пропускается.
	// Возвращаемый результат:
	// - истина - в случае успешного внедрения конфигурации в конфигурацию приложения;
	// - ложь   - в случае возникновения ошибки при внедрении конфигурации. Сама ошибка публикуется в список ошибок
	//            приложения.
	ConfigurationRegistration(c any, callback ...kitTypes.Callbacker) (isOk bool)

	// ConfigurationCallbackSubscribe Подписка функции обратного вызова на событие изменения данных сегмента
	// конфигурации. Функция будет вызвана при изменении данных конфигурации, например при перезагрузке файла
	// конфигурации или иных реализациях динамического изменения значений конфигурации.
	ConfigurationCallbackSubscribe(c any, callback kitTypes.Callbacker) (err error)

	// ConfigurationCallbackUnsubscribe Отписка функции обратного вызова на событие изменения данных сегмента
	// конфигурации.
	ConfigurationCallbackUnsubscribe(c any, callback kitTypes.Callbacker) (err error)

	// ConfigurationLoad Загрузка конфигурационного файла.
	ConfigurationLoad(buf *bytes.Buffer) (err error)

	// AbsolutePathAndUpdate Функция преобразует относительный путь в абсолютный путь,
	// проверяет равно ли новое значение старому, если значение изменилось, тогда обновляет значение в указанной
	// переменной и возвращает результирующее значение.
	AbsolutePathAndUpdate(dir *string) (ret string)
}

type Interface interface {

	// Answer Интерфейс библиотеки функций для формирования ответа на HTTP запрос к серверу.
	Answer() kitModuleAns.Interface

	// Bus Интерфейс шины данных приложения.
	Bus() kitModuleBus.Interface

	// Gist Интерфейс к служебным методам конфигурации приложения.
	Gist() Essence

	// Version Интерфейс к методам получения версии приложения.
	Version() Version

	// UUID Интерфейс к методам генерации и работы с UUID идентификаторами.
	UUID() kitModuleUuid.Interface

	// RawWriter Интерфейс вывода потоковых сообщений.
	RawWriter() kitTypes.SyncWriter

	// Server Интерфейс менеджера управления сервером.
	Server() kitModuleServer.Interface

	// Log Интерфейс к методам логирования.
	Log() kitTypes.Logger

	// Loglevel Текущий уровень логирования приложения.
	Loglevel() kitModuleLogLevel.Level

	// AppName Название приложения.
	AppName() string

	// Command Функция возвращает команду с которой было запущено приложение.
	Command() (ret string)

	// CommandFull Функция возвращает команду с которой было запущено приложение.
	CommandFull() []string

	// Debug Функция возвращает текуще значение режима отладки приложения.
	Debug() (ret bool)

	// ForkWorker Параметры работы в режиме fork worker.
	ForkWorker() *kitTypes.BootstrapConfigurationForkWorker

	// IsForkWorker Возвращает истину для режима запуска приложения в качестве подчинённого процесса основного приложения.
	// В этом режиме приложению нельзя использовать STDIN/STDOUT/STDERR, эти потоки используются для обмена данными
	// с управляющим приложением.
	// Так же, этот режим устанавливается в случае запуска приложения как daemon процесса, в этом режиме запуска, тоже
	// нельзя использовать STDIN/STDOUT/STDERR, так как режим daemon, для приложения, возможен только после полного
	// закрытия этих потоков.
	IsForkWorker() (ret bool)

	// Runlevel Возвращает текущее значение уровня работы приложения.
	Runlevel() uint16

	// RunlevelMap Возвращает карту, описывающую план переключения уровней работы приложения.
	RunlevelMap() []uint16

	// RunlevelSubscribe Подписка на события изменения уровня работы приложения.
	RunlevelSubscribe(fn RunlevelSubscriberFn) (err error)

	// RunlevelUnsubscribe Отписка от событий изменения уровня работы приложения.
	RunlevelUnsubscribe(fn RunlevelSubscriberFn) (err error)

	// RunlevelAutoincrement Режим работы автоматического увеличения уровня работы приложения.
	RunlevelAutoincrement() (ret bool)

	// Targetlevel Возвращает текущее значение целевого уровня работы приложения.
	Targetlevel() uint16

	// User Текущий пользователь операционной системы.
	User() *user.User

	// AbsolutePath Функция преобразует относительный путь в абсолютный путь к директории или файлу.
	// Учитывается символ '~' обозначающий домашнюю директорию текущего пользователя.
	AbsolutePath(pth string) (ret string)

	// DirectoryHome Значение домашней директории приложения.
	DirectoryHome() string

	// DirectoryWorking Значение рабочей директории приложения.
	DirectoryWorking() string

	// DirectoryWorkingChdir Функция выполняет переход в рабочую директорию приложения.
	// Возвращается ошибка операционной системы, с причиной не возможности перейти в рабочую директорию.
	DirectoryWorkingChdir() (err error)

	// DirectoryTemp Значение директории для временных файлов.
	DirectoryTemp() string

	// DirectoryCache Значение директории для файлов кеша.
	DirectoryCache() string

	// DirectoryConfig Значение директории для подключаемых или дополнительных конфигураций приложения.
	DirectoryConfig() string

	// FileConfig Значение пути и имени конфигурационного файла приложения.
	FileConfig() string

	// FilePid Значение пути и имени PID файла приложения.
	FilePid() string

	// FileState Значение пути и имени файла хранения состояния приложения.
	FileState() string

	// FileSocket Значение пути и имени сокет файла коммуникаций с приложением.
	FileSocket() string

	// ConfigurationUnionSprintf Печать объединённой конфигурации приложения в строку.
	ConfigurationUnionSprintf() (ret string)

	// ConfigurationByType Возвращает объект конфигурации соответствующий указанному типу объекта.
	// Если объект конфигурации с указанным типом не регистрировался, будет возвращена ошибка.
	ConfigurationByType(t reflect.Type) (ret any, err error)

	// ConfigurationByTypeName Возвращает объект конфигурации соответствующий указанному названию типа объекта.
	// Если объект конфигурации с указанным типом не регистрировался, будет возвращена ошибка.
	ConfigurationByTypeName(typeName string) (ret any, err error)

	// ConfigurationByObject Возвращает объект конфигурации соответствующий типу переданного объекта, сам переданный
	// объект никак не изменяется, он служит только для определения типа данных.
	// Если объект конфигурации с указанным типом не регистрировался, будет возвращена ошибка.
	ConfigurationByObject(o any) (ret any, err error)

	// ConfigurationCopyByObject Если существует конфигурация с типом данных идентичным переданному объекту,
	// тогда данные конфигурации копируются в переданный объект.
	// Если объект конфигурации с указанным типом не регистрировался, будет возвращена ошибка.
	// Объект должен передаваться по адресу, иначе его заполнение не возможно и будет возвращена ошибка.
	ConfigurationCopyByObject(o any) (err error)

	// Errors Справочник ошибок.
	Errors() *Error
}

type Recorder kitTypes.Logger

type RunlevelSubscriberFn func(old uint16, new uint16)

type Version interface {
	// Major returns the major version
	Major() uint64

	// Minor returns the minor version
	Minor() uint64

	// Patch returns the patch version
	Patch() uint64

	// Prerelease returns the prerelease version
	Prerelease() string

	// Metadata returns the metadata on the version
	Metadata() string

	// String converts a Version object to a string
	String() string

	// MarshalJSON implements JSON.Marshaler interface
	MarshalJSON() ([]byte, error)

	// UnmarshalJSON implements JSON.Unmarshaler interface
	UnmarshalJSON(b []byte) error
}