- License
- Subject to the terms of the MIT license, as written in the included LICENSE file.
- Authors
- Zaramzan
Config reading system.
Ctor AppConfig(string) create a config from file.
struct AppConfig;
- Authors
- Zaramzan
Represent configuration file.
this(Json json);
- Throws
- InvalidConfig if json is incorrect (without info about config file name)
- Authors
- Zaramzan
Deserializing config from provided json object.
immutable this(string path);
- Throws
- InvalidConfig
- Authors
- Zaramzan
Parsing config from file path.
struct SqlConfig;
Describes basic sql info in AppConfig
class InvalidConfig: object.Exception;
- Throws
- InvalidConfig
- Authors
- Zaramzan
The exception is thrown when configuration parsing error occurs (AppConfig constructor). Also encapsulates config file name.
class NoConfigLoaded: object.Exception;
- Authors
- NCrashed
The exception is thrown by tryConfigPaths is called and all config file alternatives are failed to be loaded.
Also encapsulates a set of tried paths.
alias LoadedConfig = std.typecons.Tuple!(immutable(AppConfig), "config", string, "path").Tuple;
- Authors
- NCrashed
Return value from tryConfigPaths. Handles loaded config and exact file path.
LoadedConfig tryConfigPaths(R)(R paths) if (isInputRange!R && is(ElementType!R == string));
- Throws
- NoConfigLoaded if can't load configuration file. InvalidConfig if configuration file is invalid (first successfully opened)
- Authors
- NCrashed
Takes range of paths and one at a time tries to load config from each one. If the path doesn't exist, then the next candidate is checked. If the file exists, but parsing or deserializing are failed, InvalidConfig exception is thrown.
If functions go out of paths and none of them can be opened, then NoConfigLoaded exception is thrown.
AppConfig defaultConfig();
- Authors
- NCrashed
Returns config example to be edited by end user.
This configuration is generated only if explicit key is passed to the application.
bool writeConfig(AppConfig appConfig, string name);
- Authors
- NCrashed
Writes configuration appConfig to file path name. It is a wrapper function around writeJson.
bool writeJson(Json json, string name);
- Authors
- NCrashed
Writes down json to provided file name.
void genConfig(string path);
- Authors
- NCrashed
Generates and write down minimal configuration to path.