package generic
- Alphabetic
- Public
- All
Type Members
-
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
-
trait
DerivedConfigReader[A] extends ConfigReader[A]
A
ConfigReader
derived withshapeless
.A
ConfigReader
derived withshapeless
.- A
the type of objects readable by this
ConfigReader
- trait DerivedConfigReader1 extends AnyRef
-
trait
DerivedConfigWriter[A] extends ConfigWriter[A]
A
ConfigWriter
derived withshapeless
.A
ConfigWriter
derived withshapeless
.- A
the type of objects writable by this
ConfigWriter
- trait DerivedConfigWriter1 extends AnyRef
-
trait
EnumerationConfigReaderBuilder[A] extends AnyRef
A type class to build
ConfigReader
s for sealed families of case objects where each type is encoded as aConfigString
based on the type name.A type class to build
ConfigReader
s for sealed families of case objects where each type is encoded as aConfigString
based on the type name.- A
the type of objects capable of being read as an enumeration
-
trait
EnumerationConfigWriterBuilder[A] extends AnyRef
A type class to build
ConfigWriter
s for sealed families of case objects where each type is encoded as aConfigString
based on the type name.A type class to build
ConfigWriter
s for sealed families of case objects where each type is encoded as aConfigString
based on the type name.- A
the type of objects capable of being written as an enumeration
-
class
ExportMacros extends AnyRef
Macros used to circunvent divergence checker restrictions in the compiler.
-
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. -
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, whileto
will write the config as is, with no disambiguation information. -
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
-
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
-
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
-
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
-
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
-
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]
andpureconfig.generic.semiauto.deriveEnumerationConvert[T]
instead
Value Members
- object CoproductHint
- object DerivedConfigReader extends DerivedConfigReader1
- object DerivedConfigWriter extends DerivedConfigWriter1
- object EnumerationConfigReaderBuilder
- object EnumerationConfigWriterBuilder
- object FieldCoproductHint
- object MapShapedReader
- object MapShapedWriter
- object ProductHint
- object SeqShapedReader
- object SeqShapedWriter
-
object
auto
An object that, when imported, provides implicit
ConfigReader
andConfigWriter
instances for value classes, tuples, case classes and sealed traits. -
object
hlist
An object that, when imported, provides readers and writers for shapeless
HList
instances. -
object
semiauto
An object that provides methods for deriving
ConfigReader
andConfigWriter
instances on demand for value classes, tuples, case classes and sealed traits.