pureconfig

Type Members

trait AllowMissingKey extends AnyRef

The default behavior of ConfigReaders that are implicitly derived in PureConfig is to raise a KeyNotFoundException when a required key is missing.
The default behavior of ConfigReaders that are implicitly derived in PureConfig is to raise a KeyNotFoundException when a required key is missing. Mixing in this trait to a ConfigReader allows customizing this behavior. When a key is missing, but the ConfigReader of the given type extends this trait, the from method of the ConfigReader is called with null.
trait BasicReaders extends PrimitiveReaders with JavaEnumReader with UriAndPathReaders with RegexReaders with JavaTimeReaders with DurationReaders with NumericReaders with TypesafeConfigReaders

Trait containing ConfigReader instances for primitive types and simple classes in Java and Scala standard libraries.
trait BasicWriters extends PrimitiveWriters with JavaEnumWriter with UriAndPathWriters with RegexWriters with JavaTimeWriters with DurationWriters with NumericWriters with TypesafeConfigWriters

Trait containing ConfigWriter instances for primitive types and simple classes in Java and Scala standard libraries.
trait CapitalizedWordsNamingConvention extends NamingConvention
trait ConfigConvert[A] extends ConfigReader[A] with ConfigWriter[A]

Trait for objects capable of reading and writing objects of a given type from and to ConfigValues.
sealed trait ConfigCursor extends AnyRef

A wrapper for a ConfigValue providing safe navigation through the config and holding positional data for better error handling.
trait ConfigFieldMapping extends (String) ⇒ String

A mapping between case class fields and their respective keys in the config.
case class ConfigListCursor(value: ConfigList, pathElems: List[String], offset: Int = 0) extends ConfigCursor with Product with Serializable

A ConfigCursor pointing to a config list.
case class ConfigObjectCursor(value: ConfigObject, pathElems: List[String]) extends ConfigCursor with Product with Serializable

A ConfigCursor pointing to a config object.
trait ConfigReader[A] extends AnyRef

Trait for objects capable of reading objects of a given type from ConfigValues.
Trait for objects capable of reading objects of a given type from ConfigValues.
A
the type of objects readable by this ConfigReader
trait ConfigWriter[A] extends AnyRef

Trait for objects capable of writing objects of a given type to ConfigValues.
Trait for objects capable of writing objects of a given type to ConfigValues.
A
the type of objects writable by this ConfigWriter
trait ConvertHelpers extends AnyRef

Useful helpers for building ConfigConvert instances and dealing with results.
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
trait DerivedReaders extends DerivedReaders1

Trait extending DerivedReaders1 that contains ConfigReader instances for AnyVal.
Trait extending DerivedReaders1 that contains ConfigReader instances for AnyVal.
This trait exists to give priority to the AnyVal derivation over the generic product derivation.
trait DerivedReaders1 extends AnyRef

Trait containing ConfigReader instances for collection, product and coproduct types.
trait DerivedWriters extends DerivedWriters1
trait DerivedWriters1 extends AnyRef

Trait containing ConfigWriter instances for collection, product and coproduct types.
trait DurationReaders extends AnyRef

Trait containing ConfigReader instances for scala.concurrent.duration.Duration and scala.concurrent.duration.FiniteDuration.
trait DurationWriters extends AnyRef

Trait containing ConfigWriter instances for scala.concurrent.duration.Duration and scala.concurrent.duration.FiniteDuration.
class EnumCoproductHint[T] extends CoproductHint[T]

Hint applicable to sealed families of case objects where objects are written and read as strings with their type names.
Hint applicable to sealed families of case objects where objects are written and read as strings with their type names. Trying to read or write values that are not case objects results in failure.
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, while to will write the config as is, with no disambiguation information.
trait JavaEnumReader extends AnyRef

Trait containing ConfigReader instance for Java Enums.
trait JavaEnumWriter extends AnyRef

Trait containing instance for ConfigWriter for Java Enum.
trait JavaTimeReaders extends AnyRef

Trait containing ConfigReader instances for java.time classes.
trait JavaTimeWriters extends AnyRef

Trait containing ConfigWriter instances for java.time classes.
trait NamingConvention extends AnyRef
trait NumericReaders extends AnyRef

Trait containing ConfigReader instances for Java and Scala arbitrary-precision numeric types.
trait NumericWriters extends AnyRef

Trait containing ConfigWriter instances for Java and Scala arbitrary-precision numeric types.
sealed trait PathSegment extends Product with Serializable
trait PrimitiveReaders extends AnyRef

Trait containing ConfigReader instances for primitive types.
trait PrimitiveWriters extends AnyRef

Trait containing ConfigWriter instances for primitive types.
trait ProductHint[T] extends AnyRef

A trait that can be implemented to customize how case classes are read from and written to a config.
A trait that can be implemented to customize how case classes are read from and written to a config.
T
the type of case class for which this hint applies
trait RegexReaders extends AnyRef

Trait containing ConfigReader instances for classes related to regular expressions.
trait RegexWriters extends AnyRef

Trait containing ConfigWriter instances for classes related to regular expressions.
case class SimpleConfigCursor(value: ConfigValue, pathElems: List[String]) extends ConfigCursor with Product with Serializable

A simple ConfigCursor providing no extra operations.
class StringDelimitedNamingConvention extends NamingConvention
trait TypesafeConfigReaders extends AnyRef

Trait containing ConfigReader instances for Typesafe config models.
trait TypesafeConfigWriters extends AnyRef

Trait containing ConfigWriter instances for Typesafe config models.
trait UriAndPathReaders extends AnyRef

Trait containing ConfigReader instances for classes related to file system paths and URIs.
trait UriAndPathWriters extends AnyRef

Trait containing ConfigWriter instances for classes related to file system paths and URIs.

Value Members

object BasicReaders extends BasicReaders
object BasicWriters extends BasicWriters
object CamelCase extends CapitalizedWordsNamingConvention

CamelCase identifiers look like camelCase and useMorePureconfig
CamelCase identifiers look like camelCase and useMorePureconfig

See also
https://en.wikipedia.org/wiki/Camel_case
object CapitalizedWordsNamingConvention
object ConfigConvert extends ConvertHelpers

Provides methods to create ConfigConvert instances.
object ConfigCursor
object ConfigFieldMapping
object ConfigReader extends BasicReaders with DerivedReaders

Provides methods to create ConfigReader instances.
object ConfigWriter extends BasicWriters with DerivedWriters

Provides methods to create ConfigWriter instances.
object ConvertHelpers extends ConvertHelpers
object CoproductHint
object DerivedReaders extends DerivedReaders
object DerivedWriters extends DerivedWriters
object KebabCase extends StringDelimitedNamingConvention

KebabCase identifiers look like kebab-case and use-more-pureconfig
KebabCase identifiers look like kebab-case and use-more-pureconfig

See also
http://wiki.c2.com/?KebabCase
object PascalCase extends CapitalizedWordsNamingConvention

PascalCase identifiers look like e.g.PascalCase and UseMorePureconfig
PascalCase identifiers look like e.g.PascalCase and UseMorePureconfig

See also
https://en.wikipedia.org/wiki/PascalCase
object PathSegment extends Serializable
object ProductHint
object SnakeCase extends StringDelimitedNamingConvention

SnakeCase identifiers look like snake_case and use_more_pureconfig
SnakeCase identifiers look like snake_case and use_more_pureconfig

See also
https://en.wikipedia.org/wiki/Snake_case
package backend
package error
def loadConfig[Config](conf: Config, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

Load a configuration of type Config from the given Config
def loadConfig[Config](conf: Config)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

Load a configuration of type Config from the given Config
def loadConfig[Config](path: Path, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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
def loadConfig[Config](path: Path)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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
def loadConfig[Config](namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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
def loadConfig[Config](implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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
def loadConfigFromFiles[Config](files: Traversable[Path], failOnReadError: Boolean = false)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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.
The behavior of the method if an element of files references a file which doesn't exist or can't be read is defined by the failOnReadError flag. With failOnReadError = false, such files will silently be ignored while otherwise they would yield a failure (a Left value).
files
Files ordered in decreasing priority containing part or all of a Config
def loadConfigFromFilesOrThrow[Config](files: Traversable[Path])(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

returns
the configuration

Annotations
@throws( ... )
See also
loadConfigFromFiles
def loadConfigOrThrow[Config](conf: Config, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

Load a configuration of type Config from the given Config
Load a configuration of type Config from the given Config
conf
Typesafe configuration to load
namespace
the base namespace from which the configuration should be load
returns
the configuration

Annotations
@throws( ... )
def loadConfigOrThrow[Config](conf: Config)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

Load a configuration of type Config from the given Config
Load a configuration of type Config from the given Config
conf
Typesafe configuration to load
returns
the configuration

Annotations
@throws( ... )
def loadConfigOrThrow[Config](path: Path, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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
the configuration

Annotations
@throws( ... )
def loadConfigOrThrow[Config](path: Path)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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
the configuration

Annotations
@throws( ... )
def loadConfigOrThrow[Config](namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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
the configuration

Annotations
@throws( ... )
def loadConfigOrThrow[Config](implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

Load a configuration of type Config from the standard configuration files
Load a configuration of type Config from the standard configuration files
returns
the configuration

Annotations
@throws( ... )
def loadConfigWithFallback[Config](conf: Config, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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
def loadConfigWithFallback[Config](conf: Config)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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
def loadConfigWithFallbackOrThrow[Config](conf: Config, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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
the configuration

Annotations
@throws( ... )
def loadConfigWithFallbackOrThrow[Config](conf: Config)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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
the configuration

Annotations
@throws( ... )
def saveConfigAsPropertyFile[Config](conf: Config, outputPath: Path, overrideOutputPath: Boolean = false, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit writer: Derivation[ConfigWriter[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
options
the config rendering options

Annotations
@throws( ... )
def saveConfigToStream[Config](conf: Config, outputStream: OutputStream, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit writer: Derivation[ConfigWriter[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
options
the config rendering options
package syntax

package pureconfig

Type Members

trait AllowMissingKey extends AnyRef

trait BasicReaders extends PrimitiveReaders with JavaEnumReader with UriAndPathReaders with RegexReaders with JavaTimeReaders with DurationReaders with NumericReaders with TypesafeConfigReaders

trait BasicWriters extends PrimitiveWriters with JavaEnumWriter with UriAndPathWriters with RegexWriters with JavaTimeWriters with DurationWriters with NumericWriters with TypesafeConfigWriters

trait CapitalizedWordsNamingConvention extends NamingConvention

trait ConfigConvert[A] extends ConfigReader[A] with ConfigWriter[A]

sealed trait ConfigCursor extends AnyRef

trait ConfigFieldMapping extends (String) ⇒ String

case class ConfigListCursor(value: ConfigList, pathElems: List[String], offset: Int = 0) extends ConfigCursor with Product with Serializable

case class ConfigObjectCursor(value: ConfigObject, pathElems: List[String]) extends ConfigCursor with Product with Serializable

trait ConfigReader[A] extends AnyRef

trait ConfigWriter[A] extends AnyRef

trait ConvertHelpers extends AnyRef

trait CoproductHint[T] extends AnyRef

trait DerivedReaders extends DerivedReaders1

trait DerivedReaders1 extends AnyRef

trait DerivedWriters extends DerivedWriters1

trait DerivedWriters1 extends AnyRef

trait DurationReaders extends AnyRef

trait DurationWriters extends AnyRef

class EnumCoproductHint[T] extends CoproductHint[T]

class FieldCoproductHint[T] extends CoproductHint[T]

class FirstSuccessCoproductHint[T] extends CoproductHint[T]

trait JavaEnumReader extends AnyRef

trait JavaEnumWriter extends AnyRef

trait JavaTimeReaders extends AnyRef

trait JavaTimeWriters extends AnyRef

trait NamingConvention extends AnyRef

trait NumericReaders extends AnyRef

trait NumericWriters extends AnyRef

sealed trait PathSegment extends Product with Serializable

trait PrimitiveReaders extends AnyRef

trait PrimitiveWriters extends AnyRef

trait ProductHint[T] extends AnyRef

trait RegexReaders extends AnyRef

trait RegexWriters extends AnyRef

case class SimpleConfigCursor(value: ConfigValue, pathElems: List[String]) extends ConfigCursor with Product with Serializable

class StringDelimitedNamingConvention extends NamingConvention

trait TypesafeConfigReaders extends AnyRef

trait TypesafeConfigWriters extends AnyRef

trait UriAndPathReaders extends AnyRef

trait UriAndPathWriters extends AnyRef

Value Members

object BasicReaders extends BasicReaders

object BasicWriters extends BasicWriters

object CamelCase extends CapitalizedWordsNamingConvention

object CapitalizedWordsNamingConvention

object ConfigConvert extends ConvertHelpers

object ConfigCursor

object ConfigFieldMapping

object ConfigReader extends BasicReaders with DerivedReaders

object ConfigWriter extends BasicWriters with DerivedWriters

object ConvertHelpers extends ConvertHelpers

object CoproductHint

object DerivedReaders extends DerivedReaders

object DerivedWriters extends DerivedWriters

object KebabCase extends StringDelimitedNamingConvention

object PascalCase extends CapitalizedWordsNamingConvention

object PathSegment extends Serializable

object ProductHint

object SnakeCase extends StringDelimitedNamingConvention

package backend

package error

def loadConfig[Config](conf: Config, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfig[Config](conf: Config)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfig[Config](path: Path, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfig[Config](path: Path)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfig[Config](namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfig[Config](implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfigFromFiles[Config](files: Traversable[Path], failOnReadError: Boolean = false)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

def loadConfigFromFilesOrThrow[Config](files: Traversable[Path])(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigOrThrow[Config](conf: Config, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigOrThrow[Config](conf: Config)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigOrThrow[Config](path: Path, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigOrThrow[Config](path: Path)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigOrThrow[Config](namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigOrThrow[Config](implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

def loadConfigWithFallback[Config](conf: Config, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]