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

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


    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
  • package numbers
    Definition Classes
  • package testing
    Definition Classes
  • IntegralString
  • JsonNumberString

package testing

  1. Alphabetic
  1. Public
  2. Protected

Type Members

  1. final case class IntegralString(value: String) extends Product with Serializable

    An integral string with an optional leading minus sign and between 1 and 25 digits (inclusive).

  2. final case class JsonNumberString(value: String) extends Product with Serializable

    An arbitrary JSON number, represented as a string.

Value Members

  1. object IntegralString extends Serializable
  2. object JsonNumberString extends Serializable