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 export
    Definition Classes
    circe
  • package syntax

    This package provides syntax via enrichment classes.

    This package provides syntax via enrichment classes.

    Definition Classes
    circe
  • ACursor
  • Codec
  • CursorOp
  • Decoder
  • DecodingFailure
  • Encoder
  • Error
  • Errors
  • FailedCursor
  • HCursor
  • Json
  • JsonNumber
  • JsonObject
  • KeyDecoder
  • KeyEncoder
  • Parser
  • ParsingFailure
  • Printer
  • disjunctionCodecs

object Json extends Serializable

Source
Json.scala
Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Json
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Folder[X] extends Serializable

    Represents a set of operations for reducing a Json instance to a value.

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 val False: Json
  5. final val Null: Json
  6. final val True: Json
  7. final def arr(values: Json*): Json

    Create a Json value representing a JSON array from values.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. implicit final val eqJson: Eq[Json]
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def fromBigDecimal(value: BigDecimal): Json

    Create a Json value representing a JSON number from a BigDecimal.

  15. final def fromBigInt(value: BigInt): Json

    Create a Json value representing a JSON number from a BigInt.

  16. final def fromBoolean(value: Boolean): Json

    Create a Json value representing a JSON boolean.

  17. final def fromDouble(value: Double): Option[Json]

    Try to create a Json value representing a JSON number from a Double.

    Try to create a Json value representing a JSON number from a Double.

    The result is empty if the argument cannot be represented as a JSON number.

  18. final def fromDoubleOrNull(value: Double): Json

    Create a Json value representing a JSON number or null from a Double.

    Create a Json value representing a JSON number or null from a Double.

    The result is a JSON null if the argument cannot be represented as a JSON number.

  19. final def fromDoubleOrString(value: Double): Json

    Create a Json value representing a JSON number or string from a Double.

    Create a Json value representing a JSON number or string from a Double.

    The result is a JSON string if the argument cannot be represented as a JSON number.

  20. final def fromFields(fields: Iterable[(String, Json)]): Json

    Create a Json value representing a JSON object from a collection of key-value pairs.

  21. final def fromFloat(value: Float): Option[Json]

    Try to create a Json value representing a JSON number from a Float.

    Try to create a Json value representing a JSON number from a Float.

    The result is empty if the argument cannot be represented as a JSON number.

  22. final def fromFloatOrNull(value: Float): Json

    Create a Json value representing a JSON number or null from a Float.

    Create a Json value representing a JSON number or null from a Float.

    The result is a JSON null if the argument cannot be represented as a JSON number.

  23. final def fromFloatOrString(value: Float): Json

    Create a Json value representing a JSON number or string from a Float.

    Create a Json value representing a JSON number or string from a Float.

    The result is a JSON string if the argument cannot be represented as a JSON number.

  24. final def fromInt(value: Int): Json

    Create a Json value representing a JSON number from an Int.

  25. final def fromJsonNumber(value: JsonNumber): Json

    Create a Json value representing a JSON number from a JsonNumber.

  26. final def fromJsonObject(value: JsonObject): Json

    Create a Json value representing a JSON object from a JsonObject.

  27. final def fromLong(value: Long): Json

    Create a Json value representing a JSON number from a Long.

  28. final def fromString(value: String): Json

    Create a Json value representing a JSON string.

    Create a Json value representing a JSON string.

    Note that this does not parse the argument.

  29. final def fromValues(values: Iterable[Json]): Json

    Create a Json value representing a JSON array from a collection of values.

  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def obj(fields: (String, Json)*): Json

    Create a Json value representing a JSON object from key-value pairs.

  37. implicit final val showJson: Show[Json]
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped