pureconfig

package pureconfig

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. pureconfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait AllowMissingKey extends AnyRef

    The default behavior of ConfigConverts that are implicitly derived in PureConfig is to raise a KeyNotFoundException when a required key is missing.

  2. trait CapitalizedWordsNamingConvention extends NamingConvention

  3. trait ConfigConvert[T] extends AnyRef

    Trait for conversion between T and ConfigValue.

  4. trait ConfigFieldMapping[T] extends (String) ⇒ String

  5. trait CoproductHint[T] extends AnyRef

    A trait that can be implemented to disambiguate between the different options of a coproduct or sealed family.

  6. class FieldCoproductHint[T] extends CoproductHint[T]

    Hint where the options are disambiguated by a key = "value" field inside the config.

  7. class FirstSuccessCoproductHint[T] extends CoproductHint[T]

    Hint where all coproduct options are tried in order.

  8. trait LowPriorityConfigConvertImplicits extends AnyRef

    Implicit ConfigConvert instances defined such that they can be overriden by library consumer via a locally defined implementation.

  9. trait LowPriorityConfigFieldMappingImplicits extends AnyRef

  10. trait NamingConvention extends AnyRef

  11. class StringDelimitedNamingConvention extends NamingConvention

Value Members

  1. object CamelCase extends CapitalizedWordsNamingConvention

    CamelCase identifiers look like camelCase and useMorePureconfig

  2. object CapitalizedWordsNamingConvention

  3. object ConfigConvert extends LowPriorityConfigConvertImplicits

  4. object ConfigFieldMapping extends LowPriorityConfigFieldMappingImplicits

  5. object CoproductHint

  6. object KebabCase extends StringDelimitedNamingConvention

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

  7. object PascalCase extends CapitalizedWordsNamingConvention

    PascalCase identifiers look like e.

  8. object SnakeCase extends StringDelimitedNamingConvention

    SnakeCase identifiers look like snake_case and use_more_pureconfig

  9. package error

  10. def loadConfig[Config](conf: Config, namespace: String)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the given Config

  11. def loadConfig[Config](conf: Config)(implicit conv: ConfigConvert[Config]): Try[Config]

    Load a configuration of type Config from the given Config

  12. 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 type Config from the configuration files, else a Failure with details on why it isn't possible

  13. 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 type Config from the configuration files, else a Failure with details on why it isn't possible

  14. def loadConfig[Config](namespace: String)(implicit conv: ConfigConvert[Config]): Try[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

  15. def loadConfig[Config](implicit conv: ConfigConvert[Config]): Try[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

  16. 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 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.

    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.

  17. def loadConfigWithFallback[Config](conf: Config, namespace: String)(implicit conv: ConfigConvert[Config]): Try[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

  18. def loadConfigWithFallback[Config](conf: Config)(implicit conv: ConfigConvert[Config]): Try[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

  19. 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( ... )

  20. 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

  21. package syntax

Inherited from AnyRef

Inherited from Any

Ungrouped