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 AllowMissingKey extends AnyRef

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

    The default behavior of ConfigReaders that are implicitly derived in PureConfig is to raise a KeyNotFoundException when a required key is missing. Mixing in this trait to a ConfigReader allows customizing this behavior. When a key is missing, but the ConfigReader of the given type extends this trait, the from method of the ConfigReader is called with null.

  2. trait BasicReaders extends PrimitiveReaders with JavaEnumReader with UriAndPathReaders with RegexReaders with JavaTimeReaders with DurationReaders with NumericReaders with TypesafeConfigReaders

    Trait containing ConfigReader instances for primitive types and simple classes in Java and Scala standard libraries.

  3. trait BasicWriters extends PrimitiveWriters with JavaEnumWriter with UriAndPathWriters with RegexWriters with JavaTimeWriters with DurationWriters with NumericWriters with TypesafeConfigWriters

    Trait containing ConfigWriter instances for primitive types and simple classes in Java and Scala standard libraries.

  4. trait CapitalizedWordsNamingConvention extends NamingConvention
  5. trait ConfigConvert[A] extends ConfigReader[A] with ConfigWriter[A]

    Trait for objects capable of reading and writing objects of a given type from and to ConfigValues.

  6. sealed trait ConfigCursor extends AnyRef

    A wrapper for a ConfigValue providing safe navigation through the config and holding positional data for better error handling.

  7. trait ConfigFieldMapping extends (String) ⇒ String

    A mapping between case class fields and their respective keys in the config.

  8. case class ConfigListCursor(value: ConfigList, pathElems: List[String], offset: Int = 0) extends ConfigCursor with Product with Serializable

    A ConfigCursor pointing to a config list.

  9. case class ConfigObjectCursor(value: ConfigObject, pathElems: List[String]) extends ConfigCursor with Product with Serializable

    A ConfigCursor pointing to a config object.

  10. trait ConfigReader[A] extends AnyRef

    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.

    A

    the type of objects readable by this ConfigReader

  11. trait ConfigWriter[A] extends AnyRef

    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.

    A

    the type of objects writable by this ConfigWriter

  12. trait ConvertHelpers extends AnyRef

    Useful helpers for building ConfigConvert instances and dealing with results.

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

  14. trait DerivedReaders extends DerivedReaders1

    Trait extending DerivedReaders1 that contains ConfigReader instances for AnyVal.

    Trait extending DerivedReaders1 that contains ConfigReader instances for AnyVal.

    This trait exists to give priority to the AnyVal derivation over the generic product derivation.

  15. trait DerivedReaders1 extends AnyRef

    Trait containing ConfigReader instances for collection, product and coproduct types.

  16. trait DerivedWriters extends DerivedWriters1
  17. trait DerivedWriters1 extends AnyRef

    Trait containing ConfigWriter instances for collection, product and coproduct types.

  18. trait DurationReaders extends AnyRef

    Trait containing ConfigReader instances for scala.concurrent.duration.Duration and scala.concurrent.duration.FiniteDuration.

  19. trait DurationWriters extends AnyRef

    Trait containing ConfigWriter instances for scala.concurrent.duration.Duration and scala.concurrent.duration.FiniteDuration.

  20. class EnumCoproductHint[T] extends CoproductHint[T]

    Hint applicable to sealed families of case objects where objects are written and read as strings with their type names.

    Hint applicable to sealed families of case objects where objects are written and read as strings with their type names. Trying to read or write values that are not case objects results in failure.

    T

    the type of the coproduct or sealed family for which this hint applies

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

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

  23. trait JavaEnumReader extends AnyRef

    Trait containing ConfigReader instance for Java Enums.

  24. trait JavaEnumWriter extends AnyRef

    Trait containing instance for ConfigWriter for Java Enum.

  25. trait JavaTimeReaders extends AnyRef

    Trait containing ConfigReader instances for java.time classes.

  26. trait JavaTimeWriters extends AnyRef

    Trait containing ConfigWriter instances for java.time classes.

  27. trait NamingConvention extends AnyRef
  28. trait NumericReaders extends AnyRef

    Trait containing ConfigReader instances for Java and Scala arbitrary-precision numeric types.

  29. trait NumericWriters extends AnyRef

    Trait containing ConfigWriter instances for Java and Scala arbitrary-precision numeric types.

  30. sealed trait PathSegment extends Product with Serializable
  31. trait PrimitiveReaders extends AnyRef

    Trait containing ConfigReader instances for primitive types.

  32. trait PrimitiveWriters extends AnyRef

    Trait containing ConfigWriter instances for primitive types.

  33. trait ProductHint[T] extends AnyRef

    A trait that can be implemented to customize how case classes are read from and written to a config.

    A trait that can be implemented to customize how case classes are read from and written to a config.

    T

    the type of case class for which this hint applies

  34. trait RegexReaders extends AnyRef

    Trait containing ConfigReader instances for classes related to regular expressions.

  35. trait RegexWriters extends AnyRef

    Trait containing ConfigWriter instances for classes related to regular expressions.

  36. case class SimpleConfigCursor(value: ConfigValue, pathElems: List[String]) extends ConfigCursor with Product with Serializable

    A simple ConfigCursor providing no extra operations.

  37. class StringDelimitedNamingConvention extends NamingConvention
  38. trait TypesafeConfigReaders extends AnyRef

    Trait containing ConfigReader instances for Typesafe config models.

  39. trait TypesafeConfigWriters extends AnyRef

    Trait containing ConfigWriter instances for Typesafe config models.

  40. trait UriAndPathReaders extends AnyRef

    Trait containing ConfigReader instances for classes related to file system paths and URIs.

  41. trait UriAndPathWriters extends AnyRef

    Trait containing ConfigWriter instances for classes related to file system paths and URIs.

Value Members

  1. def loadConfig[Config](conf: Config, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

    Load a configuration of type Config from the given Config

  2. def loadConfig[Config](conf: Config)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, Config]

    Load a configuration of type Config from the given Config

  3. def loadConfig[Config](path: Path, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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 reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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 reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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 reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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[Path], failOnReadError: Boolean = false)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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.

    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

    Files ordered in decreasing priority containing part or all of a Config

  8. def loadConfigFromFilesOrThrow[Config](files: Traversable[Path])(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    returns

    the configuration

    Annotations
    @throws( ... )
    See also

    loadConfigFromFiles

  9. def loadConfigOrThrow[Config](conf: Config, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Load a configuration of type Config from the given Config

    Load a configuration of type Config from the given Config

    conf

    Typesafe configuration to load

    namespace

    the base namespace from which the configuration should be load

    returns

    the configuration

    Annotations
    @throws( ... )
  10. def loadConfigOrThrow[Config](conf: Config)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Load a configuration of type Config from the given Config

    Load a configuration of type Config from the given Config

    conf

    Typesafe configuration to load

    returns

    the configuration

    Annotations
    @throws( ... )
  11. def loadConfigOrThrow[Config](path: Path, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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

    the configuration

    Annotations
    @throws( ... )
  12. def loadConfigOrThrow[Config](path: Path)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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

    the configuration

    Annotations
    @throws( ... )
  13. def loadConfigOrThrow[Config](namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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

    the configuration

    Annotations
    @throws( ... )
  14. def loadConfigOrThrow[Config](implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): Config

    Load a configuration of type Config from the standard configuration files

    Load a configuration of type Config from the standard configuration files

    returns

    the configuration

    Annotations
    @throws( ... )
  15. def loadConfigWithFallback[Config](conf: Config, namespace: String)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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

  16. def loadConfigWithFallback[Config](conf: Config)(implicit reader: Derivation[ConfigReader[Config]]): Either[ConfigReaderFailures, 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

  17. def loadConfigWithFallbackOrThrow[Config](conf: Config, namespace: String)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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

    the configuration

    Annotations
    @throws( ... )
  18. def loadConfigWithFallbackOrThrow[Config](conf: Config)(implicit arg0: ClassTag[Config], reader: Derivation[ConfigReader[Config]]): 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

    the configuration

    Annotations
    @throws( ... )
  19. def saveConfigAsPropertyFile[Config](conf: Config, outputPath: Path, overrideOutputPath: Boolean = false, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit writer: Derivation[ConfigWriter[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

    options

    the config rendering options

    Annotations
    @throws( ... )
  20. def saveConfigToStream[Config](conf: Config, outputStream: OutputStream, options: ConfigRenderOptions = ConfigRenderOptions.defaults())(implicit writer: Derivation[ConfigWriter[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

    options

    the config rendering options

  21. object BasicReaders extends BasicReaders
  22. object BasicWriters extends BasicWriters
  23. 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

  24. object CapitalizedWordsNamingConvention
  25. object ConfigConvert extends ConvertHelpers

    Provides methods to create ConfigConvert instances.

  26. object ConfigCursor
  27. object ConfigFieldMapping
  28. object ConfigReader extends BasicReaders with DerivedReaders

    Provides methods to create ConfigReader instances.

  29. object ConfigWriter extends BasicWriters with DerivedWriters

    Provides methods to create ConfigWriter instances.

  30. object ConvertHelpers extends ConvertHelpers
  31. object CoproductHint
  32. object DerivedReaders extends DerivedReaders
  33. object DerivedWriters extends DerivedWriters
  34. 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

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

  36. object PathSegment extends Serializable
  37. object ProductHint
  38. 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