Packages

object semiauto

Semi-automatic codec derivation.

This object provides helpers for creating io.circe.Decoder and io.circe.Encoder.AsObject instances for case classes, "incomplete" case classes, sealed trait hierarchies, etc.

Typical usage will look like the following:

import io.circe._, io.circe.generic.semiauto._

case class Foo(i: Int, p: (String, Double))

object Foo {
  implicit val decodeFoo: Decoder[Foo] = deriveConfiguredDecoder[Foo]
  implicit val encodeFoo: Encoder.AsObject[Foo] = deriveConfiguredEncoder[Foo]
}
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. semiauto
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class DerivationHelper[A] extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def deriveConfiguredCodec[A](implicit codec: Lazy[ConfiguredAsObjectCodec[A]]): AsObject[A]
  7. final def deriveConfiguredDecoder[A](implicit decode: Lazy[ConfiguredDecoder[A]]): Decoder[A]
  8. final def deriveConfiguredEncoder[A](implicit encode: Lazy[ConfiguredAsObjectEncoder[A]]): AsObject[A]
  9. final def deriveConfiguredFor[A]: DerivationHelper[A]
  10. def deriveEnumerationCodec[A](implicit codec: Lazy[EnumerationCodec[A]]): Codec[A]

    Derive a codec for a sealed trait hierarchy made up of case objects.

    Derive a codec for a sealed trait hierarchy made up of case objects.

    Note that this differs from the usual derived encoder in that the leaves of the ADT are represented as JSON strings.

  11. def deriveEnumerationDecoder[A](implicit decode: Lazy[EnumerationDecoder[A]]): Decoder[A]

    Derive a decoder for a sealed trait hierarchy made up of case objects.

    Derive a decoder for a sealed trait hierarchy made up of case objects.

    Note that this differs from the usual derived decoder in that the leaves of the ADT are represented as JSON strings.

  12. def deriveEnumerationEncoder[A](implicit encode: Lazy[EnumerationEncoder[A]]): Encoder[A]

    Derive an encoder for a sealed trait hierarchy made up of case objects.

    Derive an encoder for a sealed trait hierarchy made up of case objects.

    Note that this differs from the usual derived encoder in that the leaves of the ADT are represented as JSON strings.

  13. def deriveUnwrappedCodec[A](implicit codec: Lazy[UnwrappedCodec[A]]): Codec[A]

    Derive a codec for a value class.

  14. def deriveUnwrappedDecoder[A](implicit decode: Lazy[UnwrappedDecoder[A]]): Decoder[A]

    Derive a decoder for a value class.

  15. def deriveUnwrappedEncoder[A](implicit encode: Lazy[UnwrappedEncoder[A]]): Encoder[A]

    Derive an encoder for a value class.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. final def deriveCodec[A](implicit codec: Lazy[ConfiguredAsObjectCodec[A]]): AsObject[A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use deriveConfiguredCodec

  2. final def deriveDecoder[A](implicit decode: Lazy[ConfiguredDecoder[A]]): Decoder[A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use deriveConfiguredDecoder

  3. final def deriveEncoder[A](implicit encode: Lazy[ConfiguredAsObjectEncoder[A]]): AsObject[A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use deriveConfiguredEncoder

  4. final def deriveFor[A]: DerivationHelper[A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use deriveConfiguredFor

  5. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped