Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package circe

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    Overview

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    The library is divided into a number of modules that either provide core functionality, support additional features via third-party dependencies, or facilitate integration with other libraries or frameworks.

    • numbers: core facilities for representing and parsing JSON numbers.
    • core: our JSON abstract syntax tree, our zipper-like cursor types, and our encoding and decoding type classes (and instances).
    • parser: JSON parsing support for both the Java Virtual Machine (using Jawn) and Scala.js (using the native JavaScript JSON parser).
    • testing: ScalaCheck Arbitrary instances for circe's JSON AST and other types, as well as other useful testing tools.
    • literal: JSON string interpolation and encoder and decoder instances for literal types.
    • generic: Shapeless-powered generic derivation for case classes and sealed trait hierarchies.
    • generic-extras: additional experimental generic derivation functionality (including some configurability).
    • pointer: A JSON Pointer implementation
    • pointer-literal: JSON Pointer string interpolation
    • shapes: encoders and decoders for Shapeless hlists, coproducts, records, and sized collections.
    • scodec: encoders and decoders for Scodec's BitVector and ByteVector.
    • refined: encoders and decoders for refined types.
    • spray: Spray marshaller conversions for Circe's type classes.

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    io
  • package generic
    Definition Classes
    circe
  • package encoding
    Definition Classes
    generic
  • DerivedAsObjectEncoder
  • ReprAsObjectEncoder

abstract class ReprAsObjectEncoder[A] extends AsObject[A]

An encoder for a generic representation of a case class or ADT.

Note that users typically will not work with instances of this class.

Source
ReprAsObjectEncoder.scala
Linear Supertypes
AsObject[A], AsRoot[A], Encoder[A], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReprAsObjectEncoder
  2. AsObject
  3. AsRoot
  4. Encoder
  5. Serializable
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ReprAsObjectEncoder()

Abstract Value Members

  1. abstract def encodeObject(a: A): JsonObject

    Convert a value to a JSON object.

    Convert a value to a JSON object.

    Definition Classes
    AsObject

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toany2stringadd[ReprAsObjectEncoder[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReprAsObjectEncoder[A], B)
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toArrowAssoc[ReprAsObjectEncoder[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def apply(a: A): Json

    Convert a value to JSON.

    Convert a value to JSON.

    Definition Classes
    AsObject → Encoder
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. final def contramap[B](f: (B) => A): Encoder[B]

    Create a new Encoder by applying a function to a value of type B before encoding as an A.

    Create a new Encoder by applying a function to a value of type B before encoding as an A.

    Definition Classes
    Encoder
  10. final def contramapObject[B](f: (B) => A): AsObject[B]

    Create a new AsObject by applying a function to a value of type B before encoding as an A.

    Create a new AsObject by applying a function to a value of type B before encoding as an A.

    Definition Classes
    AsObject
  11. def ensuring(cond: (ReprAsObjectEncoder[A]) => Boolean, msg: => Any): ReprAsObjectEncoder[A]
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toEnsuring[ReprAsObjectEncoder[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ReprAsObjectEncoder[A]) => Boolean): ReprAsObjectEncoder[A]
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toEnsuring[ReprAsObjectEncoder[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ReprAsObjectEncoder[A]
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toEnsuring[ReprAsObjectEncoder[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ReprAsObjectEncoder[A]
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toEnsuring[ReprAsObjectEncoder[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toStringFormat[ReprAsObjectEncoder[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def mapJson(f: (Json) => Json): Encoder[A]

    Create a new Encoder by applying a function to the output of this one.

    Create a new Encoder by applying a function to the output of this one.

    Definition Classes
    Encoder
  23. final def mapJsonObject(f: (JsonObject) => JsonObject): AsObject[A]

    Create a new AsObject by applying a function to the output of this one.

    Create a new AsObject by applying a function to the output of this one.

    Definition Classes
    AsObject
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (ReprAsObjectEncoder[A], B)
    Implicit
    This member is added by an implicit conversion from ReprAsObjectEncoder[A] toArrowAssoc[ReprAsObjectEncoder[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AsObject[A]

Inherited from AsRoot[A]

Inherited from Encoder[A]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromReprAsObjectEncoder[A] to any2stringadd[ReprAsObjectEncoder[A]]

Inherited by implicit conversion StringFormat fromReprAsObjectEncoder[A] to StringFormat[ReprAsObjectEncoder[A]]

Inherited by implicit conversion Ensuring fromReprAsObjectEncoder[A] to Ensuring[ReprAsObjectEncoder[A]]

Inherited by implicit conversion ArrowAssoc fromReprAsObjectEncoder[A] to ArrowAssoc[ReprAsObjectEncoder[A]]

Ungrouped