p

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
Visibility
  1. Public
  2. All

Type Members

  1. trait CapitalizedWordsNamingConvention extends NamingConvention
  2. trait ConfigConvert [T] extends AnyRef

    Trait for conversion between T and ConfigValue.

  3. trait ConfigFieldMapping [T] extends (String) ⇒ String
  4. 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

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

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

  7. trait LowPriorityConfigConvertImplicits extends AnyRef

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

  8. trait LowPriorityConfigFieldMappingImplicits extends AnyRef
  9. trait NamingConvention extends AnyRef
  10. class StringDelimitedNamingConvention extends NamingConvention

Value Members

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

    Load a configuration of type Config from the given Config

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

    Load a configuration of type Config from the given Config

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

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

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

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

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

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

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

  10. 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( ... )
  11. 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

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

  13. object CapitalizedWordsNamingConvention
  14. object ConfigConvert extends LowPriorityConfigConvertImplicits
  15. object ConfigFieldMapping extends LowPriorityConfigFieldMappingImplicits
  16. object CoproductHint
  17. 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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped