Type Members

1.  abstract class ACursor extends Serializable

   A zipper that represents a position in a JSON document and supports navigation and modification.

   A zipper that represents a position in a JSON document and supports navigation and modification.

   The focus represents the current position of the cursor; it may be updated with withFocus or changed using navigation methods like left and right.

2.  trait Codec[A] extends Decoder[A] with Encoder[A]

   A type class that provides back and forth conversion between values of type A and the Json format.

   A type class that provides back and forth conversion between values of type A and the Json format.

   Note that this type class is only intended to make instance definition more convenient; it generally should not be used as a constraint.

   Instances should obey the laws defined in io.circe.testing.CodecLaws.

3.  sealed abstract class CursorOp extends Product with Serializable
4.  trait Decoder[A] extends Serializable

   A type class that provides a way to produce a value of type A from a Json value.

5.  sealed abstract class DecodingFailure extends Error

   An exception representing a decoding failure and (lazily) capturing the decoding history resulting in the failure.

6.  trait Encoder[A] extends Serializable

   A type class that provides a conversion from a value of type A to a Json value.

7.  sealed abstract class Error extends Exception

   The base exception type for both decoding and parsing errors.

8.  final case class Errors(errors: NonEmptyList[Error]) extends Exception with Product with Serializable

   A convenience exception type for aggregating one or more decoding or parsing errors.

9.  final class FailedCursor extends ACursor
10.  abstract class HCursor extends ACursor
11.  sealed abstract class Json extends Product with Serializable

    A data type representing possible JSON values.

12.  sealed abstract class JsonNumber extends Serializable

    A JSON number with optimization by cases.

13.  sealed abstract class JsonObject extends Serializable

    A mapping from keys to JSON values that maintains insertion order.

14.  trait KeyDecoder[A] extends Serializable

    A type class that provides a conversion from a string used as a JSON key to a value of type A.

15.  trait KeyEncoder[A] extends Serializable

    A type class that provides a conversion from a value of type A to a string.

    A type class that provides a conversion from a value of type A to a string.

    This type class will be used to create strings for JSON keys when encoding Map[A, ?] instances as JSON.

    Note that if more than one value maps to the same string, the resulting JSON object may have fewer fields than the original map.

16.  trait Parser extends Serializable
17.  final case class ParsingFailure(message: String, underlying: Throwable) extends Error with Product with Serializable

    An exception representing a parsing failure and wrapping the exception provided by the parsing library.

18.  final case class Printer(dropNullValues: Boolean, indent: String, lbraceLeft: String = "", lbraceRight: String = "", rbraceLeft: String = "", rbraceRight: String = "", lbracketLeft: String = "", lbracketRight: String = "", rbracketLeft: String = "", rbracketRight: String = "", lrbracketsEmpty: String = "", arrayCommaLeft: String = "", arrayCommaRight: String = "", objectCommaLeft: String = "", objectCommaRight: String = "", colonLeft: String = "", colonRight: String = "", reuseWriters: Boolean = false, predictSize: Boolean = false, escapeNonAscii: Boolean = false, sortKeys: Boolean = false) extends Product with Serializable

    A pretty-printer for JSON values.

    A pretty-printer for JSON values.

    dropNullValues

    Determines if object fields with values of null are dropped from the output.

    indent

    The indentation to use if any format strings contain a new line.

    lbraceLeft

    Spaces to insert to left of a left brace.

    lbraceRight

    Spaces to insert to right of a left brace.

    rbraceLeft

    Spaces to insert to left of a right brace.

    rbraceRight

    Spaces to insert to right of a right brace.

    lbracketLeft

    Spaces to insert to left of a left bracket.

    lbracketRight

    Spaces to insert to right of a left bracket.

    rbracketLeft

    Spaces to insert to left of a right bracket.

    rbracketRight

    Spaces to insert to right of a right bracket.

    lrbracketsEmpty

    Spaces to insert for an empty array.

    arrayCommaLeft

    Spaces to insert to left of a comma in an array.

    arrayCommaRight

    Spaces to insert to right of a comma in an array.

    objectCommaLeft

    Spaces to insert to left of a comma in an object.

    objectCommaRight

    Spaces to insert to right of a comma in an object.

    colonLeft

    Spaces to insert to left of a colon.

    colonRight

    Spaces to insert to right of a colon.

    reuseWriters

    Determines whether the printer will reuse Appendables via thread-local storage.

    predictSize

    Uses an adaptive size predictor to avoid grow-and-copy steps while printing into a binary output.

    escapeNonAscii

    Unicode-escape any non-ASCII characters in strings.

    sortKeys

    Determines whether the fields should be sorted.