mirage.config

Base utilities for working with configurations.

Members

Aliases

SubstituteConfigVariables
alias SubstituteConfigVariables = Flag!"SubstituteConfigVariables"

Used in a ConfigDictionary to enable to disable config path substitution.

SubstituteEnvironmentVariables
alias SubstituteEnvironmentVariables = Flag!"SubstituteEnvironmentVariables"

Used in a ConfigDictionary to enable to disable environment variable substitution.

Classes

ArrayNode
class ArrayNode

A configuration item that is an array.

ConfigCreationException
class ConfigCreationException

Used by ConfigFactory instances when loading or parsing configuration fails.

ConfigDictionary
class ConfigDictionary

A ConfigDictionary contains the configuration tree and facilities to get values from that tree.

ConfigFactory
class ConfigFactory

The base class used by configuration factories for specific file types.

ConfigPathNotFoundException
class ConfigPathNotFoundException

Used by ConfigDictionary when the supplied path does not exist.

ConfigReadException
class ConfigReadException

Used by the ConfigDictionary when something goes wrong when reading configuration.

ObjectNode
class ObjectNode

A configuration item that is an object.

PathParseException
class PathParseException

Used by ConfigDictionary when there is something wrong with the path when calling ConfigDictionary.get()

ValueNode
class ValueNode

A configuration item that is any sort of primitive value (strings, numbers or null).

Functions

loadConfig
ConfigDictionary loadConfig(string configPath)
Undocumented in source. Be warned that the author may not have intended to support it.

Interfaces

ConfigNode
interface ConfigNode

The configuration tree is made up of specific types of ConfigNodes. Used as generic type for ConfigFactory and ConfigDictionary.

Meta

Authors

Mike Bierlee, m.bierlee@lostmoment.com

License

This software is licensed under the terms of the MIT license. The full terms of the license can be found in the LICENSE file.