Packages

trait ConfigProvider extends AnyRef

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

Self Type
ConfigProvider
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigProvider
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def contramapPath(f: (String) => String): ConfigProvider

    Returns a new config provider that will automatically tranform all path configuration names with the specified function.

    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.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def flatten: Flat

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

  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def kebabCase: ConfigProvider

    Returns a new config provider that will automatically convert all property names to kebab case.

    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.

    Note: This method now correctly handles numbers in camelCase names (e.g., "myValue123" becomes "my-value-123"). For backward compatibility with the legacy behavior, use kebabCaseLegacy.

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

    Loads the configuration of type A using implicit Config[A], or fails with a config error.

  15. final def lowerCase: ConfigProvider

    Returns a new config provider that will automatically convert all property names to lower case.

    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.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def nested(name: String): ConfigProvider

    Returns a new config provider that will automatically nest all configuration under the specified property name.

    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.

  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def orElse(that: ConfigProvider): ConfigProvider

    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.

  21. final def snakeCase: ConfigProvider

    Returns a new config provider that will automatically convert all property names to snake case.

    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.

    Note: This method now correctly handles numbers in camelCase names (e.g., "myValue123" becomes "my_value_123"). For backward compatibility with the legacy behavior, use snakeCaseLegacy.

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def unnested(name: String): ConfigProvider

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

  25. final def upperCase: ConfigProvider

    Returns a new config provider that will automatically convert all property names to upper case.

    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.

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def within(path: Chunk[String])(f: (ConfigProvider) => ConfigProvider): ConfigProvider

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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. final def kebabCaseLegacy: ConfigProvider

    Legacy implementation of kebab case conversion that maintains backward compatibility with ZIO 2.0.x behavior.

    Legacy implementation of kebab case conversion that maintains backward compatibility with ZIO 2.0.x behavior. This method does not handle numbers in camelCase names (e.g., "myValue123" becomes "my-value123").

    Consider migrating to kebabCase for better handling of numbers.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.20) Use kebabCase for improved number handling

  3. final def snakeCaseLegacy: ConfigProvider

    Legacy implementation of snake case conversion that maintains backward compatibility with ZIO 2.0.x behavior.

    Legacy implementation of snake case conversion that maintains backward compatibility with ZIO 2.0.x behavior. This method does not handle numbers in camelCase names (e.g., "myValue123" becomes "my_value123").

    Consider migrating to snakeCase for improved number handling.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use snakeCase for improved number handling

Inherited from AnyRef

Inherited from Any

Ungrouped