Trait containing ConfigReader
instances for primitive types and simple classes in Java and Scala standard
libraries.
Trait containing ConfigWriter
instances for primitive types and simple classes in Java and Scala standard
libraries.
Trait containing ConfigReader
instances for collection types.
Trait containing ConfigWriter
instances for collection types.
Trait for objects capable of reading and writing objects of a given type from and to ConfigValues
.
A wrapper for a ConfigValue
providing safe navigation through the config and holding positional data for better
error handling.
A mapping between case class fields and their respective keys in the config.
A ConfigCursor
pointing to a config list.
A ConfigCursor
pointing to a config object.
A ConfigSource
which is guaranteed to generate config objects (maps) as root values.
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
.
the type of objects readable by this ConfigReader
A representation of a source from which ConfigValue
s can be loaded, such as a file or a URL.
A representation of a source from which ConfigValue
s can be loaded, such as a file or a URL.
A source allows users to load configs from this source as any type for which a ConfigReader
is
available. Raw configs can also be retrieved as a ConfigValue
, a ConfigCursor
or a
FluentConfigCursor
. Before using any of the loading methods described, Users can opt to focus
on a specific part of a config by specifying a namespace.
All config loading methods are lazy and defer resolution of references until needed.
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
.
the type of objects writable by this ConfigWriter
Useful helpers for building ConfigConvert
instances and dealing with results.
Trait containing ConfigReader
instances for scala.concurrent.duration.Duration and
scala.concurrent.duration.FiniteDuration.
Trait containing ConfigWriter
instances for scala.concurrent.duration.Duration and
scala.concurrent.duration.FiniteDuration.
A wrapper for type class instances intended to allow implicits in scope by import
statements to have lower
priority than implicits in the relevant companion objects.
A wrapper for type class instances intended to allow implicits in scope by import
statements to have lower
priority than implicits in the relevant companion objects. This behavior requires type classes to provide a bridge
in their companion objects, as done by ConfigReader
(see pureconfig.ExportedReaders) and ConfigWriter
(see
pureconfig.ExportedWriters).
the type class
the type class instance to wrap
Trait allowing ConfigReader
instances exported via Exported
to be used.
Trait allowing ConfigReader
instances exported via Exported
to be used.
This trait should be the last to be mixed into ConfigReader
's companion object so that exported readers will
always have lower precedence than ConfigReader
instances exposed as implicits through the usual means.
Trait allowing ConfigWriter
instances exported via Exported
to be used.
Trait allowing ConfigWriter
instances exported via Exported
to be used.
This trait should be the last to be mixed into ConfigWriter
's companion object so that exported writers will
always have lower precedence than ConfigWriter
instances exposed as implicits through the usual means.
A compatibility layer for creating CanBuildFrom
-like generic methods that work both on Scala 2.13 and pre-2.13
versions.
A compatibility layer for creating CanBuildFrom
-like generic methods that work both on Scala 2.13 and pre-2.13
versions.
the type of elements that get added to the builder
the type of collection that it produces
A version of ConfigCursor
with a more fluent interface, focused on config navigation instead of error handling.
A version of ConfigCursor
with a more fluent interface, focused on config navigation instead of error handling.
The at
method, used to access object and list values, is available without a previous need to cast the cursor and
always returns another cursor instead of a ConfigReader.Result
. The error handling is left for the last step, where users
can opt to cast to a primitive value using one of the as
methods or by requesting a regular cursor with cursor
.
the regular cursor pointed to by this object, wrapped itself into a Right
, or a Left
with a list of
failures in case an error occurred during navigation
Trait containing ConfigReader
instance for Java Enums.
Trait containing instance for ConfigWriter
for Java Enum.
Trait containing ConfigReader
instances for java.time
classes.
Trait containing ConfigWriter
instances for java.time
classes.
Trait containing ConfigReader
instances for Java and Scala arbitrary-precision numeric types.
Trait containing ConfigWriter
instances for Java and Scala arbitrary-precision numeric types.
Trait containing ConfigReader
instances for primitive types.
Trait containing ConfigWriter
instances for primitive types.
A marker trait signaling that a ConfigReader
accepts missing (undefined) values.
A marker trait signaling that a ConfigReader
accepts missing (undefined) values.
The standard behavior of ConfigReader
s that expect required keys in config objects is to return a KeyNotFound
failure when one or more of them are missing. Mixing in this trait into the key's ConfigReader
signals that if
a value is missing for the key, the ConfigReader
can be called with a cursor in the "undefined" state.
Trait containing ConfigReader
instances for classes related to regular expressions.
Trait containing ConfigWriter
instances for classes related to regular expressions.
A simple ConfigCursor
providing no extra operations.
Trait containing ConfigReader
instances for Typesafe config models.
Trait containing ConfigWriter
instances for Typesafe config models.
Trait containing ConfigReader
instances for classes related to file system paths and URIs.
Trait containing ConfigWriter
instances for classes related to file system paths and URIs.
A trait signaling that a ConfigWriter
can write missing (undefined) values.
A trait signaling that a ConfigWriter
can write missing (undefined) values.
ConfigWriter
s always produce a valid ConfigValue
with their to
method. This trait adds an extra toOpt
method that parent writers can use in order to decide whether or not they should write a value using this writer.
CamelCase identifiers look like camelCase
and useMorePureconfig
CamelCase identifiers look like camelCase
and useMorePureconfig
https://en.wikipedia.org/wiki/Camel_case
Provides methods to create ConfigConvert instances.
Provides methods to create ConfigReader instances.
Object containing factory methods for building ConfigSource
s.
Object containing factory methods for building ConfigSource
s.
The sources provided here use Typesafe Config configs created from files, resources, URLs or
strings. It also provides sources that delegate the loading component to Typesafe Config, to
leverage reference configs and overrides, making it easy to switch from using ConfigFactory
to ConfigSource
.
Other PureConfig modules may provide other ways or building config sources (e.g. for different config formats or data sources).
Provides methods to create ConfigWriter instances.
KebabCase identifiers look like kebab-case
and use-more-pureconfig
KebabCase identifiers look like kebab-case
and use-more-pureconfig
http://wiki.c2.com/?KebabCase
PascalCase identifiers look like e.g.PascalCase
and UseMorePureconfig
PascalCase identifiers look like e.g.PascalCase
and UseMorePureconfig
https://en.wikipedia.org/wiki/PascalCase
SnakeCase identifiers look like snake_case
and use_more_pureconfig
SnakeCase identifiers look like snake_case
and use_more_pureconfig
https://en.wikipedia.org/wiki/Snake_case
Save the given configuration into a property file
Save the given configuration into a property file
The configuration to save
Where to write the configuration
Override the path if it already exists
the config rendering options
Writes the configuration to the output stream and closes the stream
Writes the configuration to the output stream and closes the stream
The configuration to write
The stream in which the configuration should be written
the config rendering options
Load a configuration of type A
from the given Config
Load a configuration of type A
from the given Config
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).at(namespace).load[A]
instead
Load a configuration of type A
from the given Config
Load a configuration of type A
from the given Config
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).load[A]
instead
Load a configuration of type A
from the given file.
Load a configuration of type A
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
the base namespace from which the configuration should be load
A Success
with the configuration if it is possible to create an instance of type
A
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.12.0) Use ConfigSource.default(ConfigSource.file(path)).at(namespace).load[A]
instead
Load a configuration of type A
from the given file.
Load a configuration of type A
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
A Success
with the configuration if it is possible to create an instance of type
A
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.12.0) Use ConfigSource.default(ConfigSource.file(path)).load[A]
instead
Load a configuration of type A
from the standard configuration files
Load a configuration of type A
from the standard configuration files
the base namespace from which the configuration should be load
A Success
with the configuration if it is possible to create an instance of type
A
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.12.0) Use ConfigSource.default.at(namespace).load[A]
instead
Load a configuration of type A
from the standard configuration files
Load a configuration of type A
from the standard configuration files
A Success
with the configuration if it is possible to create an instance of type
A
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.12.0) Use ConfigSource.default.load[A]
instead
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 ordered in decreasing priority containing part or all of a Config
Where to return an error if any files fail to read
the base namespace from which the configuration should be load
(Since version 0.12.0) Construct a custom ConfigSource
pipeline instead
the configuration
(Since version 0.12.0) Construct a custom ConfigSource
pipeline instead
Load a configuration of type A
from the given Config
Load a configuration of type A
from the given Config
Typesafe configuration to load
the base namespace from which the configuration should be load
the configuration
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).at(namespace).loadOrThrow[A]
instead
Load a configuration of type A
from the given Config
Load a configuration of type A
from the given Config
Typesafe configuration to load
the configuration
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).loadOrThrow[A]
instead
Load a configuration of type A
from the given file.
Load a configuration of type A
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
the base namespace from which the configuration should be load
the configuration
(Since version 0.12.0) Use ConfigSource.default(ConfigSource.file(path)).at(namespace).loadOrThrow[A]
instead
Load a configuration of type A
from the given file.
Load a configuration of type A
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
the configuration
(Since version 0.12.0) Use ConfigSource.default(ConfigSource.file(path)).loadOrThrow[A]
instead
Load a configuration of type A
from the standard configuration files
Load a configuration of type A
from the standard configuration files
the base namespace from which the configuration should be load
the configuration
(Since version 0.12.0) Use ConfigSource.default.at(namespace).loadOrThrow[A]
instead
Load a configuration of type A
from the standard configuration files
Load a configuration of type A
from the standard configuration files
the configuration
(Since version 0.12.0) Use ConfigSource.default.loadOrThrow[A]
instead
Load a configuration of type A
from the given Config
, falling back to the default configuration
Load a configuration of type A
from the given Config
, falling back to the default configuration
Typesafe configuration to load
the base namespace from which the configuration should be load
A Success
with the configuration if it is possible to create an instance of type
A
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).withFallback(ConfigSource.default).at(namespace).load[A]
instead
Load a configuration of type A
from the given Config
, falling back to the default configuration
Load a configuration of type A
from the given Config
, falling back to the default configuration
Typesafe configuration to load
A Success
with the configuration if it is possible to create an instance of type
A
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).withFallback(ConfigSource.default).load[A]
instead
Load a configuration of type A
from the given Config
, falling back to the default configuration
Load a configuration of type A
from the given Config
, falling back to the default configuration
Typesafe configuration to load
the base namespace from which the configuration should be load
the configuration
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).withFallback(ConfigSource.default).at(namespace).loadOrThrow[A]
instead
Load a configuration of type A
from the given Config
, falling back to the default configuration
Load a configuration of type A
from the given Config
, falling back to the default configuration
Typesafe configuration to load
the configuration
(Since version 0.12.0) Use ConfigSource.fromConfig(conf).withFallback(ConfigSource.default).loadOrThrow[A]
instead