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 benchmark
    Definition Classes
    circe
  • package export
    Definition Classes
    circe
  • package generic
    Definition Classes
    circe
  • package hygiene
    Definition Classes
    circe
  • package jawn
    Definition Classes
    circe
  • CirceSupportParser
  • JawnParser
  • package literal
    Definition Classes
    circe
  • package numbers
    Definition Classes
    circe
  • package pointer
    Definition Classes
    circe
  • package refined
    Definition Classes
    circe
  • package scalajs
    Definition Classes
    circe
  • package shapes
    Definition Classes
    circe
  • package syntax

    This package provides syntax via enrichment classes.

    This package provides syntax via enrichment classes.

    Definition Classes
    circe
  • package testing
    Definition Classes
    circe

package jawn

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. jawn
  2. JawnParser
  3. Parser
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class CirceSupportParser extends SupportParser[Json] with Serializable
  2. class JawnParser extends Parser

Abstract Value Members

  1. abstract def getClass(): Class[_ <: AnyRef]
    Definition Classes
    Any
  2. abstract def parse(input: String): Either[ParsingFailure, Json]
    Definition Classes
    Parser

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. final def decode[A](input: String)(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    Parser
  6. final def decodeAccumulating[A](input: String)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    Parser
  7. final def decodeByteArray[A](bytes: Array[Byte])(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    JawnParser
  8. final def decodeByteArrayAccumulating[A](bytes: Array[Byte])(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    JawnParser
  9. final def decodeByteBuffer[A](buffer: ByteBuffer)(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    JawnParser
  10. final def decodeByteBufferAccumulating[A](buffer: ByteBuffer)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    JawnParser
  11. final def decodeChannel[A](ch: ReadableByteChannel)(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    JawnParser
  12. final def decodeChannelAccumulating[A](ch: ReadableByteChannel)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    JawnParser
  13. final def decodeCharSequence[A](cs: CharSequence)(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    JawnParser
  14. final def decodeCharSequenceAccumulating[A](cs: CharSequence)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    JawnParser
  15. final def decodeFile[A](file: File)(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    JawnParser
  16. final def decodeFileAccumulating[A](file: File)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    JawnParser
  17. final def decodePath[A](path: Path)(implicit arg0: Decoder[A]): Either[Error, A]
    Definition Classes
    JawnParser
  18. final def decodePathAccumulating[A](path: Path)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]
    Definition Classes
    JawnParser
  19. def equals(arg0: Any): Boolean
    Definition Classes
    Any
  20. final def finishDecode[A](input: Either[ParsingFailure, Json])(implicit decoder: Decoder[A]): Either[Error, A]
    Attributes
    protected[this]
    Definition Classes
    Parser
  21. final def finishDecodeAccumulating[A](input: Either[ParsingFailure, Json])(implicit decoder: Decoder[A]): ValidatedNel[Error, A]
    Attributes
    protected[this]
    Definition Classes
    Parser
  22. def hashCode(): Int
    Definition Classes
    Any
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def parseByteArray(bytes: Array[Byte]): Either[ParsingFailure, Json]
    Definition Classes
    JawnParser
  25. final def parseByteBuffer(buffer: ByteBuffer): Either[ParsingFailure, Json]
    Definition Classes
    JawnParser
  26. final def parseChannel(ch: ReadableByteChannel): Either[ParsingFailure, Json]
    Definition Classes
    JawnParser
  27. final def parseCharSequence(cs: CharSequence): Either[ParsingFailure, Json]
    Definition Classes
    JawnParser
  28. final def parseFile(file: File): Either[ParsingFailure, Json]
    Definition Classes
    JawnParser
  29. final def parsePath(path: Path): Either[ParsingFailure, Json]
    Definition Classes
    JawnParser
  30. def toString(): String
    Definition Classes
    Any
  31. object CirceSupportParser extends CirceSupportParser
  32. object JawnParser extends Serializable

Inherited from JawnParser

Inherited from Parser

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped