+
+
Module mirage.config Base utilities for working with configurations.
+
+
+
+
+ Interfaces
+
+
+ Name Description
+
+
+
+
+ ConfigNode
+
+
+ The configuration tree is made up of specific types of ConfigNodes.
+ Used as generic type for ConfigFactory and ConfigDictionary.
+
+
+
+
+
+ Classes
+
+
+ Name Description
+
+
+
+
+ ArrayNode
+
+
+ A configuration item that is an array.
+
+
+
+
+
+ ConfigCreationException
+
+
+ Used by ConfigFactory instances when loading or parsing configuration fails.
+
+
+
+
+
+ ConfigDictionary
+
+
+ A ConfigDictionary contains the configuration tree and facilities to get values from that tree.
+
+
+
+
+
+ ConfigFactory
+
+
+ The base class used by configuration factories for specific file types.
+
+
+
+
+
+ ConfigPathNotFoundException
+
+
+ Used by ConfigDictionary when the supplied path does not exist.
+
+
+
+
+
+ ConfigReadException
+
+
+ Used by the ConfigDictionary when something goes wrong when reading configuration.
+
+
+
+
+
+ ObjectNode
+
+
+ A configuration item that is an object.
+
+
+
+
+
+ PathParseException
+
+
+ Used by ConfigDictionary when there is something wrong with the path when calling ConfigDictionary.get()
+
+
+
+
+
+ ValueNode
+
+
+ A configuration item that is any sort of primitive value (strings, numbers or null).
+
+
+
+
+
+ Aliases
+
+
+ Name Type Description
+
+
+
+
+ SubstituteConfigVariables
+
+
+
+ std . typecons . Flag !("SubstituteConfigVariables")
+ Used in a ConfigDictionary to enable to disable config path substitution.
+
+
+
+
+
+ SubstituteEnvironmentVariables
+
+
+
+ std . typecons . Flag !("SubstituteEnvironmentVariables")
+ Used in a ConfigDictionary to enable to disable environment variable substitution.
+
+
+
+
+
+
+
+
+
Class ArrayNode A configuration item that is an array.
+
+
+
Contains other ConfigNodes as children.
+
+
+
+
+
+
+
+
+
Class ConfigCreationException Used by ConfigFactory instances when loading or parsing configuration fails.
+
+
+
+
+ class ConfigCreationException
+ object . Exception
+ ;
+
+
+
+
+
+
+
+
+
+
ConfigDictionary.get - multiple declarations
+
+
+ Function ConfigDictionary.get Get values from the configuration using config path notation.
+
+
+
+
+ string get
+ (
+ string configPath ,
+ string defaultValue = null
+ ) ;
+
+
+
+
+
+
Parameters
+Name Description configPath Path to the wanted config value. The path is separated by dots, e.g. "server.public.hostname".
+ Values from arrays can be selected by brackets, for example: "server[3].hostname.ports[0]".
+ When the config is just a value, for example just a string, it can be fetched by just specifying "." as path.
+ Although the path should be universally the same over all types of config files, some might not lend to this structure,
+ and have a more specific way of retrieving data from the config. See the examples and specific config factories for
+ more details. defaultValue (Optional) Value to return when the given configPath is invalid. When not supplied a ConfigPathNotFoundException exception is thrown.
+
+
Throws
+ConfigReadException when something goes wrong reading the config.
+ ConfigPathNotFoundException when the given path does not exist in the config.
+
+
+
Returns
+The value at the path in the configuration. To convert it use get!T().
+
+
+
Function ConfigDictionary.get Get values from the configuration and attempts to convert them to the specified type.
+
+
+
+
+ ConvertToType get (ConvertToType)
+ (
+ string configPath
+ ) ;
+
+
+
+
+
+
Parameters
+Name Description configPath Path to the wanted config value. See get().
+
+
Throws
+ConfigReadException when something goes wrong reading the config.
+ ConfigPathNotFoundException when the given path does not exist in the config.
+
+
+
Returns
+The value at the path in the configuration.
+
+
+
+
Function ConfigDictionary.get Get values from the configuration and attempts to convert them to the specified type.
+
+
+
+
+ ConvertToType get (ConvertToType)
+ (
+ string configPath ,
+ ConvertToType defaultValue
+ ) ;
+
+
+
+
+
+
Parameters
+Name Description configPath Path to the wanted config value. See get(). defaultValue (Optional) Value to return when the given configPath is invalid. When not supplied a ConfigPathNotFoundException exception is thrown.
+
+
Throws
+ConfigReadException when something goes wrong reading the config.
+ ConfigPathNotFoundException when the given path does not exist in the config.
+
+
+
Returns
+The value at the path in the configuration.
+
+
+
+
+
+
+
+
+
Function ConfigDictionary.getConfig Fetch a sub-section of the config as another config.
+
+
+
Commonly used for example to fetch further configuration from arrays, e.g.: getConfig ( "http.servers[3]" )
+
+
+
Parameters
+Name Description configPath Path to the wanted config. See get().
+
+
Returns
+A sub-section of the configuration.
+
+
+
+
+
+
+
+
Class ConfigDictionary A ConfigDictionary contains the configuration tree and facilities to get values from that tree.
+
+
+
+
+ class ConfigDictionary
+ ;
+
+
+
+
+
Methods
+
+
+ Name Description
+
+
+
+
+ get
+
+ (configPath, defaultValue)
+
+ Get values from the configuration using config path notation.
+
+
+
+
+
+ get
+
+ (configPath)
+
+ Get values from the configuration and attempts to convert them to the specified type.
+
+
+
+
+
+ get
+
+ (configPath, defaultValue)
+
+ Get values from the configuration and attempts to convert them to the specified type.
+
+
+
+
+
+ getConfig
+
+ (configPath)
+
+ Fetch a sub-section of the config as another config.
+
+
+
+
+
+ set
+
+ (configPath, value)
+
+ Assign a value at the given path.
+
+
+
+
+
+
+
+
+
+
Function ConfigDictionary.set Assign a value at the given path.
+
+
+
+
+ void set
+ (
+ string configPath ,
+ string value
+ ) ;
+
+
+
+
+
+
Parameters
+Name Description configPath Path where to assign the value to. If the path does not exist, it will be created. value Value to set at path.
+
+
+
+
+
+
+
Class ConfigFactory The base class used by configuration factories for specific file types.
+
+
+
+
+ class ConfigFactory
+ ;
+
+
+
+
+
Methods
+
+
+ Name Description
+
+
+
+
+ loadFile
+
+ (path)
+
+ Loads a configuration from the specified path from disk.
+
+
+
+
+
+ parseConfig
+
+ (contents)
+
+ Parse configuration from the given string.
+
+
+
+
+
+
+
+
+
+
Function ConfigFactory.loadFile Loads a configuration from the specified path from disk.
+
+
+
+
+
Parameters
+Name Description path Path to file. OS dependent, but UNIX paths are generally working.
+
+
Returns
+The parsed configuration.
+
+
+
+
+
+
+
+
Function ConfigFactory.parseConfig Parse configuration from the given string.
+
+
+
+
+
Parameters
+Name Description contents Text contents of the config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
+
+
+
+
+
Interface ConfigNode The configuration tree is made up of specific types of ConfigNodes.
+ Used as generic type for ConfigFactory and ConfigDictionary.
+
+
+
+
+ interface ConfigNode
+ ;
+
+
+
+
+
+
+
+
+
+
Class ConfigPathNotFoundException Used by ConfigDictionary when the supplied path does not exist.
+
+
+
+
+ class ConfigPathNotFoundException
+ object . Exception
+ ;
+
+
+
+
+
+
+
+
+
+
Class ConfigReadException Used by the ConfigDictionary when something goes wrong when reading configuration.
+
+
+
+
+ class ConfigReadException
+ object . Exception
+ ;
+
+
+
+
+
+
+
+
+
+
Class ObjectNode A configuration item that is an object.
+
+
+
ObjectNodes contain a node dictionary that points to other ConfigNodes.
+
+
+
+
+
+
+
+
+
Class PathParseException Used by ConfigDictionary when there is something wrong with the path when calling ConfigDictionary.get()
+
+
+
+
+ class PathParseException
+ object . Exception
+ ;
+
+
+
+
+
+
+
+
+
+
Alias SubstituteConfigVariables Used in a ConfigDictionary to enable to disable config path substitution.
+
+
+
+
+ alias SubstituteConfigVariables
+ = std . typecons . Flag !("SubstituteConfigVariables");
+
+
+
+
+
+
+
+
+
+
Alias SubstituteEnvironmentVariables Used in a ConfigDictionary to enable to disable environment variable substitution.
+
+
+
+
+ alias SubstituteEnvironmentVariables
+ = std . typecons . Flag !("SubstituteEnvironmentVariables");
+
+
+
+
+
+
+
+
+
+
Class ValueNode A configuration item that is any sort of primitive value (strings, numbers or null).
+
+
+
+
+
+
+
+
+
Module mirage.java Utilities for loading Java properties files.
+
+
+
+
+ Functions
+
+
+ Name Description
+
+
+
+
+ loadJavaProperties (filePath)
+
+
+ Load a Java properties file from disk.
+
+
+
+
+
+ parseJavaProperties (properties)
+
+
+ Parse Java properties from the given Java properties string.
+
+
+
+
+
+ Classes
+
+
+ Name Description
+
+
+
+
+ JavaPropertiesFactory
+
+
+ Creates configuration files from Java properties.
+
+
+
+
+
+
+
+
+
Class JavaPropertiesFactory Creates configuration files from Java properties.
+
+
+
+
Methods
+
+
+ Name Description
+
+
+
+
+ parseConfig
+
+ (contents)
+
+ Parse configuration from the given Java properties string.
+
+
+
+
+
+ loadFile
+
+ (path)
+
+ Loads a configuration from the specified path from disk.
+
+
+
+
+
+
+
+
+
+
Function JavaPropertiesFactory.parseConfig Parse configuration from the given Java properties string.
+
+
+
+
+
Parameters
+Name Description contents Text contents of the config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
+
+
+
+
+
Function loadJavaProperties Load a Java properties file from disk.
+
+
+
+
+
Parameters
+Name Description filePath Path to the Java properties file.
+
+
Returns
+The loaded configuration.
+
+
+
+
+
+
+
+
Function parseJavaProperties Parse Java properties from the given Java properties string.
+
+
+
+
+
ConfigDictionary parseJavaProperties
+
(
+
+
const ( string ) properties
+
+
) ;
+
+
+
+
+
Parameters
+Name Description properties Text contents of the config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
+
+
+
+
+
Module mirage.json Utilities for loading JSON configurations.
+
+
+
+
+ Functions
+
+
+ Name Description
+
+
+
+
+ loadJsonConfig (filePath)
+
+
+ Load a JSON configuration file from disk.
+
+
+
+
+
+ parseJsonConfig (json)
+
+
+ Parse JSON config from the given JSON string.
+
+
+
+
+
+ parseJsonConfig (json)
+
+
+ Parse JSON config from the given JSONValue.
+
+
+
+
+
+ Classes
+
+
+ Name Description
+
+
+
+
+ JsonConfigFactory
+
+
+ Creates configuration dictionaries from JSONs.
+
+
+
+
+
+
+
+
+
Class JsonConfigFactory Creates configuration dictionaries from JSONs.
+
+
+
+
Methods
+
+
+ Name Description
+
+
+
+
+ parseConfig
+
+ (contents)
+
+ Parse configuration from the given JSON string.
+
+
+
+
+
+ parseJson
+
+ (json)
+
+ Parse configuration from a JSONValue tree.
+
+
+
+
+
+ parseJson
+
+ (json)
+
+ Alias for parseConfig
+
+
+
+
+
+ loadFile
+
+ (path)
+
+ Loads a configuration from the specified path from disk.
+
+
+
+
+
+
+
+
+
+
Function JsonConfigFactory.parseConfig Parse configuration from the given JSON string.
+
+
+
+
+
Parameters
+Name Description contents Text contents of the config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
+
+
+
+
+
JsonConfigFactory.parseJson - multiple declarations
+
+
+ Function JsonConfigFactory.parseJson Parse configuration from a JSONValue tree.
+
+
+
+
+
Parameters
+Name Description json JSONValue config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
Function JsonConfigFactory.parseJson Alias for parseConfig
+
+
+
+
+
Parameters
+Name Description json Text contents of the config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
See Also
+parseConfig
+
+
+
+
+
+
+
+
Function loadJsonConfig Load a JSON configuration file from disk.
+
+
+
+
+
Parameters
+Name Description filePath Path to the JSON configuration file.
+
+
Returns
+The loaded configuration.
+
+
+
+
+
+
+
+
parseJsonConfig - multiple declarations
+
+
+ Function parseJsonConfig Parse JSON config from the given JSON string.
+
+
+
+
+
Parameters
+Name Description json Text contents of the config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
Function parseJsonConfig Parse JSON config from the given JSONValue.
+
+
+
+
+
ConfigDictionary parseJsonConfig
+
(
+
+
const ( std . json . JSONValue ) json
+
+
) ;
+
+
+
+
+
Parameters
+Name Description json JSONValue config to be parsed.
+
+
Returns
+The parsed configuration.
+
+
+
+
+
+