pureconfig

Value Members

1. object ConfigConvert extends LowPriorityConfigConvertImplicits

   

2. package error

   

3. def loadConfig[Config](conf: Config, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

   

   Load a configuration of type Config from the given Config

4. def loadConfig[Config](conf: Config)(implicit conv: ConfigConvert[Config]): Try[Config]

   

   Load a configuration of type Config from the given Config

5. def loadConfig[Config](path: Path, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

   

   Load a configuration of type Config from the given file.

   Load a configuration of type Config from the given file. Note that standard configuration files are still loaded but can be overridden from the given configuration file

   namespace

   the base namespace from which the configuration should be load

   returns

   A Success with the configuration if it is possible to create an instance of type Config from the configuration files, else a Failure with details on why it isn't possible

6. def loadConfig[Config](path: Path)(implicit conv: ConfigConvert[Config]): Try[Config]

   

   Load a configuration of type Config from the given file.

   Load a configuration of type Config from the given file. Note that standard configuration files are still loaded but can be overridden from the given configuration file

   returns

   A Success with the configuration if it is possible to create an instance of type Config from the configuration files, else a Failure with details on why it isn't possible

7. def loadConfig[Config](namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

   

   Load a configuration of type Config from the standard configuration files

   Load a configuration of type Config from the standard configuration files

   namespace

   the base namespace from which the configuration should be load

   returns

   A Success with the configuration if it is possible to create an instance of type Config from the configuration files, else a Failure with details on why it isn't possible

8. def loadConfig[Config](implicit conv: ConfigConvert[Config]): Try[Config]

   

   Load a configuration of type Config from the standard configuration files

   Load a configuration of type Config from the standard configuration files

   returns

   A Success with the configuration if it is possible to create an instance of type Config from the configuration files, else a Failure with details on why it isn't possible

9. def loadConfigFromFiles[Config](files: Traversable[File])(implicit arg0: ConfigConvert[Config]): Try[Config]

   

   Loads files in order, allowing values in later files to backstop missing values from prior, and converts them into a Config.

   Loads files in order, allowing values in later files to backstop missing values from prior, and converts them into a Config.

   This is a convenience method which enables having default configuration which backstops local configuration.

   Note: If an element of files references a file which doesn't exist or can't be read, it will silently be ignored.

   files

   Files ordered in decreasing priority containing part or all of a Config. Must not be empty.

10. def loadConfigWithFallback[Config](conf: Config, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

    

    Load a configuration of type Config from the given Config, falling back to the default configuration

    Load a configuration of type Config from the given Config, falling back to the default configuration

    conf

    Typesafe configuration to load

    namespace

    the base namespace from which the configuration should be load

    returns

    A Success with the configuration if it is possible to create an instance of type Config from the configuration files, else a Failure with details on why it isn't possible

11. def loadConfigWithFallback[Config](conf: Config)(implicit conv: ConfigConvert[Config]): Try[Config]

    

    Load a configuration of type Config from the given Config, falling back to the default configuration

    Load a configuration of type Config from the given Config, falling back to the default configuration

    conf

    Typesafe configuration to load

    returns

    A Success with the configuration if it is possible to create an instance of type Config from the configuration files, else a Failure with details on why it isn't possible

12. def saveConfigAsPropertyFile[Config](conf: Config, outputPath: Path, overrideOutputPath: Boolean = false)(implicit conv: ConfigConvert[Config]): Unit

    

    Save the given configuration into a property file

    Save the given configuration into a property file

    conf

    The configuration to save

    outputPath

    Where to write the configuration

    overrideOutputPath

    Override the path if it already exists

    Annotations

    @throws( ... )

13. def saveConfigToStream[Config](conf: Config, outputStream: OutputStream)(implicit conv: ConfigConvert[Config]): Unit

    

    Writes the configuration to the output stream and closes the stream

    Writes the configuration to the output stream and closes the stream

    conf

    The configuration to write

    outputStream

    The stream in which the configuration should be written

14. package syntax