ConfigProvider

zio.ConfigProvider
See theConfigProvider companion object

A ConfigProvider is a service that provides configuration given a description of the structure of that configuration.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Abstract methods

def load[A](config: Config[A])(implicit trace: Trace): IO[Error, A]

Loads the specified configuration, or fails with a config error.

Loads the specified configuration, or fails with a config error.

Attributes

Concrete methods

Returns a new config provider that will automatically tranform all path configuration names with the specified function. This can be utilized to adapt the names of configuration properties from one naming convention to another.

Returns a new config provider that will automatically tranform all path configuration names with the specified function. This can be utilized to adapt the names of configuration properties from one naming convention to another.

Attributes

Flattens this config provider into a simplified config provider that knows only how to deal with flat (key/value) properties.

Flattens this config provider into a simplified config provider that knows only how to deal with flat (key/value) properties.

Attributes

Returns a new config provider that will automatically convert all property names to kebab case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Returns a new config provider that will automatically convert all property names to kebab case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Attributes

Returns a new config provider that will automatically convert all property names to lower case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Returns a new config provider that will automatically convert all property names to lower case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Attributes

final def nested(name: String): ConfigProvider

Returns a new config provider that will automatically nest all configuration under the specified property name. This can be utilized to aggregate separate configuration sources that are all required to load a single configuration value.

Returns a new config provider that will automatically nest all configuration under the specified property name. This can be utilized to aggregate separate configuration sources that are all required to load a single configuration value.

Attributes

Returns a new config provider that preferentially loads configuration data from this one, but which will fall back to the specified alternate provider if there are any issues loading the configuration from this provider.

Returns a new config provider that preferentially loads configuration data from this one, but which will fall back to the specified alternate provider if there are any issues loading the configuration from this provider.

Attributes

Returns a new config provider that will automatically convert all property names to snake case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Returns a new config provider that will automatically convert all property names to snake case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Attributes

final def unnested(name: String): ConfigProvider

Returns a new config provider that will automatically unnest all configuration from the specified property name.

Returns a new config provider that will automatically unnest all configuration from the specified property name.

Attributes

Returns a new config provider that will automatically convert all property names to upper case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Returns a new config provider that will automatically convert all property names to upper case. This can be utilized to adapt the names of configuration properties from the default naming convention of camel case to the naming convention of a config provider.

Attributes

Returns a new config provider that transforms the config provider with the specified function within the specified path.

Returns a new config provider that transforms the config provider with the specified function within the specified path.

Attributes