configReaderDerivation

izumi.distage.config.codec.PureconfigInstances.configReaderDerivation

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

final class CaseClassProductConfigReader[A](labels: Array[String], readTuple: (Array[ConfigCursor], Array[KeyNotFound]) => Either[ConfigReaderFailures, A]) extends ConfigReader[A]

Attributes

Supertypes
trait ConfigReader[A]
class Object
trait Matchable
class Any
final case class InvalidCoproductOption(option: String) extends FailureReason

A failure reason given when a provided coproduct option is invalid. This likely signals a bug in a CoproductHint implementation, since the provided option isn't a valid one for the CoproductHint's type.

A failure reason given when a provided coproduct option is invalid. This likely signals a bug in a CoproductHint implementation, since the provided option isn't a valid one for the CoproductHint's type.

Value parameters

option

the coproduct option that is invalid

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FailureReason
class Object
trait Matchable
class Any
Show all
final case class NoValidCoproductOptionFound(value: ConfigValue, optionFailures: Seq[(String, ConfigReaderFailures)]) extends FailureReason

A failure reason given when a valid option for a coproduct cannot be found.

A failure reason given when a valid option for a coproduct cannot be found.

Value parameters

optionFailures

the failures produced when attempting to read coproduct options

value

the ConfigValue that was unable to be mapped to a coproduct option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FailureReason
class Object
trait Matchable
class Any
Show all
final class SealedTraitConfigReader[A](labels: List[String], readers: List[ConfigReader[A]]) extends ConfigReader[A]

Attributes

Supertypes
trait ConfigReader[A]
class Object
trait Matchable
class Any
final class TupleProductConfigReader[A](tupleSize: Int, readTuple: (Array[ConfigCursor], Array[KeyNotFound]) => Either[ConfigReaderFailures, A]) extends ConfigReader[A]

Attributes

Supertypes
trait ConfigReader[A]
class Object
trait Matchable
class Any

Value members

Concrete methods

inline def deriveForSubtype[A0, A]: ConfigReader[A]
inline def deriveForSubtypes[T <: Tuple, A]: List[ConfigReader[A]]
inline def derived[A](using m: Of[A]): ConfigReader[A]
inline def derivedProduct[A](using m: ProductOf[A]): ConfigReader[A]

Override pureconfig's default kebab-case fields – force CamelCase product-hint

Override pureconfig's default kebab-case fields – force CamelCase product-hint

Attributes

inline def derivedSum[A](using m: SumOf[A]): ConfigReader[A]

Override pureconfig's default type field type discriminator for sealed traits. Instead, use circe-like format with a single-key object. Example:

Override pureconfig's default type field type discriminator for sealed traits. Instead, use circe-like format with a single-key object. Example:

 sealed trait AorB
 final case class A(a: Int) extends AorB
 final case class B(b: String) extends AorB

 final case class Config(values: List[AorB])

in config:

 config {
   values = [{ A { a = 5 } }, { B { b = cba } }]
 }

Attributes

inline def readTuple[T <: Tuple, N <: Int](cursors: Array[ConfigCursor], keyNotFound: Array[KeyNotFound]): Either[ConfigReaderFailures, T]
inline def summonConfigReader[A]: ConfigReader[A]

Concrete fields

val fieldMapping: ConfigFieldMapping