pureconfig
package pureconfig
- Alphabetic
- By Inheritance
- pureconfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- trait CapitalizedWordsNamingConvention extends NamingConvention
-
trait
ConfigConvert
[T] extends AnyRef
Trait for conversion between
T
andConfigValue
. - trait ConfigFieldMapping [T] extends (String) ⇒ String
-
trait
CoproductHint
[T] extends AnyRef
A trait that can be implemented to disambiguate between the different options of a coproduct or sealed family.
A trait that can be implemented to disambiguate between the different options of a coproduct or sealed family.
- T
the type of the coproduct or sealed family for which this hint applies
-
class
FieldCoproductHint
[T] extends CoproductHint[T]
Hint where the options are disambiguated by a
key = "value"
field inside the config.Hint where the options are disambiguated by a
key = "value"
field inside the config.This hint will cause derived
ConfigConvert
instance to fail to convert configs to objects if the object has a field with the same name as the disambiguation key.By default, the field value written is the class or coproduct option name converted to lower case. This mapping can be changed by overriding the method
fieldValue
of this class. -
class
FirstSuccessCoproductHint
[T] extends CoproductHint[T]
Hint where all coproduct options are tried in order.
Hint where all coproduct options are tried in order.
from
will choose the first option able to deserialize the config without errors, whileto
will write the config as is, with no disambiguation information. -
trait
LowPriorityConfigConvertImplicits
extends AnyRef
Implicit ConfigConvert instances defined such that they can be overriden by library consumer via a locally defined implementation.
- trait LowPriorityConfigFieldMappingImplicits extends AnyRef
- trait NamingConvention extends AnyRef
- class StringDelimitedNamingConvention extends NamingConvention
Value Members
-
def
loadConfig[Config](conf: Config, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]
Load a configuration of type
Config
from the givenConfig
-
def
loadConfig[Config](conf: Config)(implicit conv: ConfigConvert[Config]): Try[Config]
Load a configuration of type
Config
from the givenConfig
-
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 typeConfig
from the configuration files, else aFailure
with details on why it isn't possible
-
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 typeConfig
from the configuration files, else aFailure
with details on why it isn't possible
-
def
loadConfig[Config](namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]
Load a configuration of type
Config
from the standard configuration filesLoad 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 typeConfig
from the configuration files, else aFailure
with details on why it isn't possible
-
def
loadConfig[Config](implicit conv: ConfigConvert[Config]): Try[Config]
Load a configuration of type
Config
from the standard configuration filesLoad 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 typeConfig
from the configuration files, else aFailure
with details on why it isn't possible
-
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 aConfig
.Loads
files
in order, allowing values in later files to backstop missing values from prior, and converts them into aConfig
.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.
-
def
loadConfigWithFallback[Config](conf: Config, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]
Load a configuration of type
Config
from the givenConfig
, falling back to the default configurationLoad a configuration of type
Config
from the givenConfig
, 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 typeConfig
from the configuration files, else aFailure
with details on why it isn't possible
-
def
loadConfigWithFallback[Config](conf: Config)(implicit conv: ConfigConvert[Config]): Try[Config]
Load a configuration of type
Config
from the givenConfig
, falling back to the default configurationLoad a configuration of type
Config
from the givenConfig
, 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 typeConfig
from the configuration files, else aFailure
with details on why it isn't possible
-
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( ... )
-
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
-
object
CamelCase
extends CapitalizedWordsNamingConvention
CamelCase identifiers look like
camelCase
anduseMorePureconfig
CamelCase identifiers look like
camelCase
anduseMorePureconfig
- See also
https://en.wikipedia.org/wiki/Camel_case
- object CapitalizedWordsNamingConvention
- object ConfigConvert extends LowPriorityConfigConvertImplicits
- object ConfigFieldMapping extends LowPriorityConfigFieldMappingImplicits
- object CoproductHint
-
object
KebabCase
extends StringDelimitedNamingConvention
KebabCase identifiers look like
kebab-case
anduse-more-pureconfig
KebabCase identifiers look like
kebab-case
anduse-more-pureconfig
- See also
http://wiki.c2.com/?KebabCase
-
object
PascalCase
extends CapitalizedWordsNamingConvention
PascalCase identifiers look like e.g.
PascalCase
andUseMorePureconfig
PascalCase identifiers look like e.g.
PascalCase
andUseMorePureconfig
- See also
https://en.wikipedia.org/wiki/PascalCase
-
object
SnakeCase
extends StringDelimitedNamingConvention
SnakeCase identifiers look like
snake_case
anduse_more_pureconfig
SnakeCase identifiers look like
snake_case
anduse_more_pureconfig
- See also
https://en.wikipedia.org/wiki/Snake_case