final case class JsonCodec[A](encoder: JsonEncoder[A], decoder: JsonDecoder[A]) extends Product with Serializable

A JsonCodec[A] instance has the ability to encode values of type A into JSON, together with the ability to decode such JSON into values of type A.

Instances of this trait should satisfy round-tripping laws: that is, for every value, instances must be able to successfully encode the value into JSON, and then successfully decode the same value from such JSON.

For more information, see JsonDecoder and JsonEncoder.

{{ val intCodec: JsonCodec[Int] = JsonCodec[Int]

intCodec.encodeJson(intCodec.encodeJson(42)) == Right(42) }}

Self Type
JsonCodec[A]
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonCodec
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JsonCodec(encoder: JsonEncoder[A], decoder: JsonDecoder[A])

Value Members

  1. final def *>[B](that: => JsonCodec[B])(implicit ev: <:<[Unit, A]): JsonCodec[B]
  2. final def <*(that: => JsonCodec[Unit]): JsonCodec[A]
  3. final def <*>[B](that: => JsonCodec[B]): JsonCodec[(A, B)]

    An alias for JsonCodec#zip.

  4. final def <+>[B](that: => JsonCodec[B]): JsonCodec[Either[A, B]]

    An alias for JsonCodec#orElseEither.

  5. final def <>(that: => JsonCodec[A]): JsonCodec[A]

    An alias for JsonCodec#orElse.

  6. final def decodeJson(str: CharSequence): Either[String, A]
  7. val decoder: JsonDecoder[A]
  8. final def encodeJson(a: A, indent: Option[Int]): CharSequence
  9. val encoder: JsonEncoder[A]
  10. final def orElse(that: => JsonCodec[A]): JsonCodec[A]
  11. final def orElseEither[B](that: => JsonCodec[B]): JsonCodec[Either[A, B]]
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. final def transform[B](f: (A) => B, g: (B) => A): JsonCodec[B]
  14. final def transformOrFail[B](f: (A) => Either[String, B], g: (B) => A): JsonCodec[B]
  15. final def zip[B](that: => JsonCodec[B]): JsonCodec[(A, B)]
  16. final def zipLeft(that: => JsonCodec[Unit]): JsonCodec[A]
  17. final def zipRight[B](that: => JsonCodec[B])(implicit ev: <:<[Unit, A]): JsonCodec[B]