generic

Type Members

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

2. trait DerivedConfigReader[A] extends ConfigReader[A]

   

   A ConfigReader derived with shapeless.

   A ConfigReader derived with shapeless.

   A

   the type of objects readable by this ConfigReader

3. trait DerivedConfigReader1 extends AnyRef

   

4. trait DerivedConfigWriter[A] extends ConfigWriter[A]

   

   A ConfigWriter derived with shapeless.

   A ConfigWriter derived with shapeless.

   A

   the type of objects writable by this ConfigWriter

5. trait DerivedConfigWriter1 extends AnyRef

   

6. trait EnumerationConfigReaderBuilder[A] extends AnyRef

   

   A type class to build ConfigReaders for sealed families of case objects where each type is encoded as a ConfigString based on the type name.

   A type class to build ConfigReaders for sealed families of case objects where each type is encoded as a ConfigString based on the type name.

   A

   the type of objects capable of being read as an enumeration

7. trait EnumerationConfigWriterBuilder[A] extends AnyRef

   

   A type class to build ConfigWriters for sealed families of case objects where each type is encoded as a ConfigString based on the type name.

   A type class to build ConfigWriters for sealed families of case objects where each type is encoded as a ConfigString based on the type name.

   A

   the type of objects capable of being written as an enumeration

8. class ExportMacros extends AnyRef

   

   Macros used to circunvent divergence checker restrictions in the compiler.

9. 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 kebab case. This mapping can be changed by overriding the method fieldValue of this class.

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

11. trait MapShapedReader[Wrapped, Repr] extends ConfigReader[Repr]

    

    A ConfigReader for generic representations that reads values in the shape of a config object.

    A ConfigReader for generic representations that reads values in the shape of a config object.

    Wrapped

    the original type for which Repr is a generic sub-representation

    Repr

    the generic representation

12. trait MapShapedWriter[Wrapped, Repr] extends ConfigWriter[Repr]

    

    A ConfigWriter for generic representations that writes values in the shape of a config object.

    A ConfigWriter for generic representations that writes values in the shape of a config object.

    Wrapped

    the original type for which Repr is a generic sub-representation

    Repr

    the generic representation

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

14. trait SeqShapedReader[Repr] extends ConfigReader[Repr]

    

    A ConfigReader for generic representations that reads values in the shape of a sequence.

    A ConfigReader for generic representations that reads values in the shape of a sequence.

    Repr

    the generic representation

15. trait SeqShapedWriter[Repr] extends ConfigWriter[Repr]

    

    A ConfigWriter for generic representations that writes values in the shape of a sequence.

    A ConfigWriter for generic representations that writes values in the shape of a sequence.

    Repr

    the generic representation

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

    Annotations

    @deprecated

    Deprecated

    (Since version 0.11.0) Use pureconfig.generic.semiauto.deriveEnumerationReader[T], pureconfig.generic.semiauto.deriveEnumerationWriter[T] and pureconfig.generic.semiauto.deriveEnumerationConvert[T] instead