Type Members

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

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

3.  trait CapitalizedWordsNamingConvention extends NamingConvention
4.  trait CollectionReaders extends AnyRef

   Trait containing ConfigReader instances for collection types.

5.  trait CollectionWriters extends AnyRef

   Trait containing ConfigWriter instances for collection types.

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

7.  sealed trait ConfigCursor extends AnyRef

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

8.  trait ConfigFieldMapping extends (String) => String

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

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

   A ConfigCursor pointing to a config list.

10.  case class ConfigObjectCursor(objValue: ConfigObject, pathElems: List[String]) extends ConfigCursor with Product with Serializable

    A ConfigCursor pointing to a config object.

11.  final class ConfigObjectSource extends ConfigSource

    A ConfigSource which is guaranteed to generate config objects (maps) as root values.

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

13.  trait ConfigSource extends AnyRef

    A representation of a source from which ConfigValues can be loaded, such as a file or a URL.

    A representation of a source from which ConfigValues can be loaded, such as a file or a URL.

    A source allows users to load configs from this source as any type for which a ConfigReader is available. Raw configs can also be retrieved as a ConfigValue, a ConfigCursor or a FluentConfigCursor. Before using any of the loading methods described, Users can opt to focus on a specific part of a config by specifying a namespace.

    All config loading methods are lazy and defer resolution of references until needed.

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

15.  trait ConvertHelpers extends AnyRef

    Useful helpers for building ConfigConvert instances and dealing with results.

16.  trait DurationReaders extends AnyRef

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

17.  trait DurationWriters extends AnyRef

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

18.  final case class Exported[A](instance: A) extends AnyVal with Product with Serializable

    A wrapper for type class instances intended to allow implicits in scope by import statements to have lower priority than implicits in the relevant companion objects.

    A wrapper for type class instances intended to allow implicits in scope by import statements to have lower priority than implicits in the relevant companion objects. This behavior requires type classes to provide a bridge in their companion objects, as done by ConfigReader (see pureconfig.ExportedReaders) and ConfigWriter (see pureconfig.ExportedWriters).

    A

    the type class

    instance

    the type class instance to wrap

19.  trait ExportedReaders extends AnyRef

    Trait allowing ConfigReader instances exported via Exported to be used.

    Trait allowing ConfigReader instances exported via Exported to be used.

    This trait should be the last to be mixed into ConfigReader's companion object so that exported readers will always have lower precedence than ConfigReader instances exposed as implicits through the usual means.

20.  trait ExportedWriters extends AnyRef

    Trait allowing ConfigWriter instances exported via Exported to be used.

    Trait allowing ConfigWriter instances exported via Exported to be used.

    This trait should be the last to be mixed into ConfigWriter's companion object so that exported writers will always have lower precedence than ConfigWriter instances exposed as implicits through the usual means.

21.  case class FluentConfigCursor(cursor: Result[ConfigCursor]) extends Product with Serializable

    A version of ConfigCursor with a more fluent interface, focused on config navigation instead of error handling.

    A version of ConfigCursor with a more fluent interface, focused on config navigation instead of error handling.

    The at method, used to access object and list values, is available without a previous need to cast the cursor and always returns another cursor instead of a ConfigReader.Result. The error handling is left for the last step, where users can opt to cast to a primitive value using one of the as methods or by requesting a regular cursor with cursor.

    cursor

    the regular cursor pointed to by this object, wrapped itself into a Right, or a Left with a list of failures in case an error occurred during navigation

22.  trait JavaEnumReader extends AnyRef

    Trait containing ConfigReader instance for Java Enums.

23.  trait JavaEnumWriter extends AnyRef

    Trait containing instance for ConfigWriter for Java Enum.

24.  trait JavaTimeReaders extends AnyRef

    Trait containing ConfigReader instances for java.time classes.

25.  trait JavaTimeWriters extends AnyRef

    Trait containing ConfigWriter instances for java.time classes.

26.  trait NamingConvention extends AnyRef
27.  trait NumericReaders extends AnyRef

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

28.  trait NumericWriters extends AnyRef

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

29.  sealed trait PathSegment extends Product with Serializable
30.  trait PrimitiveReaders extends AnyRef

    Trait containing ConfigReader instances for primitive types.

31.  trait PrimitiveWriters extends AnyRef

    Trait containing ConfigWriter instances for primitive types.

32.  trait ProductReaders extends AnyRef
33.  trait ProductWriters extends AnyRef
34.  trait ReaderDerives extends AnyRef
35.  trait ReadsMissingKeys extends AnyRef

    A marker trait signaling that a ConfigReader accepts missing (undefined) values.

    A marker trait signaling that a ConfigReader accepts missing (undefined) values.

    The standard behavior of ConfigReaders that expect required keys in config objects is to return a KeyNotFound failure when one or more of them are missing. Mixing in this trait into the key's ConfigReader signals that if a value is missing for the key, the ConfigReader can be called with a cursor in the "undefined" state.

36.  trait RegexReaders extends AnyRef

    Trait containing ConfigReader instances for classes related to regular expressions.

37.  trait RegexWriters extends AnyRef

    Trait containing ConfigWriter instances for classes related to regular expressions.

38.  case class SimpleConfigCursor(valueOpt: Option[ConfigValue], pathElems: List[String]) extends ConfigCursor with Product with Serializable

    A simple ConfigCursor providing no extra operations.

39.  class StringDelimitedNamingConvention extends NamingConvention
40.  trait TypesafeConfigReaders extends AnyRef

    Trait containing ConfigReader instances for Typesafe config models.

41.  trait TypesafeConfigWriters extends AnyRef

    Trait containing ConfigWriter instances for Typesafe config models.

42.  trait UriAndPathReaders extends AnyRef

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

43.  trait UriAndPathWriters extends AnyRef

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

44.  trait WritesMissingKeys[A] extends AnyRef

    A trait signaling that a ConfigWriter can write missing (undefined) values.

    A trait signaling that a ConfigWriter can write missing (undefined) values.

    ConfigWriters always produce a valid ConfigValue with their to method. This trait adds an extra toOpt method that parent writers can use in order to decide whether or not they should write a value using this writer.