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 codec
    Definition Classes
    generic
  • package decoding
    Definition Classes
    generic
  • package encoding
    Definition Classes
    generic
  • package util
    Definition Classes
    generic
  • AutoDerivation
  • Deriver
  • JsonCodec
  • semiauto

class Deriver extends DerivationMacros[ReprDecoder, ReprAsObjectEncoder, ReprAsObjectCodec, DerivedDecoder, DerivedAsObjectEncoder, DerivedAsObjectCodec]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Deriver
  2. DerivationMacros
  3. AnyRef
  4. 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 Deriver(c: Context)

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 Deriver toany2stringadd[Deriver] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Deriver, B)
    Implicit
    This member is added by an implicit conversion from Deriver toArrowAssoc[Deriver] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val DC: scala.reflect.macros.Universe.TypeTag[DerivedAsObjectCodec[_]]
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  7. val DD: scala.reflect.macros.Universe.TypeTag[DerivedDecoder[_]]
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  8. val DE: scala.reflect.macros.Universe.TypeTag[DerivedAsObjectEncoder[_]]
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  9. val RC: scala.reflect.macros.Universe.TypeTag[ReprAsObjectCodec[_]]
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  10. val RD: scala.reflect.macros.Universe.TypeTag[ReprDecoder[_]]
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  11. val RE: scala.reflect.macros.Universe.TypeTag[ReprAsObjectEncoder[_]]
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  12. val ReprDecoderUtils: scala.reflect.macros.Universe.Symbol
    Definition Classes
    DerivationMacros
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. val c: Context
    Definition Classes
    Deriver → DerivationMacros
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def constructCodec[R](implicit R: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Tree
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  17. def constructDecoder[R](implicit R: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Tree
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  18. def constructEncoder[R](implicit R: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Tree
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  19. def decodeAccumulatingMethodArgs: List[scala.reflect.macros.Universe.Tree]
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  20. val decodeAccumulatingMethodName: scala.reflect.macros.Universe.TermName
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  21. def decodeField(name: String, decode: scala.reflect.macros.Universe.TermName): scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  22. def decodeFieldAccumulating(name: String, decode: scala.reflect.macros.Universe.TermName): scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  23. def decodeMethodArgs: List[scala.reflect.macros.Universe.Tree]
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  24. val decodeMethodName: scala.reflect.macros.Universe.TermName
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  25. def decodeSubtype(name: String, decode: scala.reflect.macros.Universe.TermName): scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  26. def decodeSubtypeAccumulating(name: String, decode: scala.reflect.macros.Universe.TermName): scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  27. def deriveCodec[R](implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Expr[ReprAsObjectCodec[R]]
  28. def deriveDecoder[R](implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Expr[ReprDecoder[R]]
  29. def deriveEncoder[R](implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Expr[ReprAsObjectEncoder[R]]
  30. def encodeField(name: String, encode: scala.reflect.macros.Universe.TermName, value: scala.reflect.macros.Universe.TermName): scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  31. def encodeMethodArgs: List[scala.reflect.macros.Universe.Tree]
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  32. val encodeMethodName: scala.reflect.macros.Universe.TermName
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  33. def encodeSubtype(name: String, encode: scala.reflect.macros.Universe.TermName, value: scala.reflect.macros.Universe.TermName): scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  34. def ensuring(cond: (Deriver) => Boolean, msg: => Any): Deriver
    Implicit
    This member is added by an implicit conversion from Deriver toEnsuring[Deriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  35. def ensuring(cond: (Deriver) => Boolean): Deriver
    Implicit
    This member is added by an implicit conversion from Deriver toEnsuring[Deriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  36. def ensuring(cond: Boolean, msg: => Any): Deriver
    Implicit
    This member is added by an implicit conversion from Deriver toEnsuring[Deriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  37. def ensuring(cond: Boolean): Deriver
    Implicit
    This member is added by an implicit conversion from Deriver toEnsuring[Deriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  40. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  41. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Deriver toStringFormat[Deriver] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  42. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def hlistEncoderParts(members: Members): (List[scala.reflect.macros.whitebox.Context.Tree], scala.reflect.macros.whitebox.Context.Tree)
    Attributes
    protected[this]
    Definition Classes
    DerivationMacros
  45. val hnilReprCodec: scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  46. val hnilReprDecoder: scala.reflect.macros.Universe.Tree
    Attributes
    protected[this]
    Definition Classes
    Deriver → DerivationMacros
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (Deriver, B)
    Implicit
    This member is added by an implicit conversion from Deriver toArrowAssoc[Deriver] 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 DerivationMacros[ReprDecoder, ReprAsObjectEncoder, ReprAsObjectCodec, DerivedDecoder, DerivedAsObjectEncoder, DerivedAsObjectCodec]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDeriver to any2stringadd[Deriver]

Inherited by implicit conversion StringFormat fromDeriver to StringFormat[Deriver]

Inherited by implicit conversion Ensuring fromDeriver to Ensuring[Deriver]

Inherited by implicit conversion ArrowAssoc fromDeriver to ArrowAssoc[Deriver]

Ungrouped