circe

Type Members

1. sealed abstract class ACursor extends GenericCursor[ACursor]

   

   A cursor that tracks history and represents the possibility of failure.

   A cursor that tracks history and represents the possibility of failure.

   See also

   GenericCursor

2. sealed trait AccumulatingDecoder[A] extends Serializable

   

3. trait ArrayEncoder[A] extends RootEncoder[A]

   

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

4. sealed abstract class Context extends Serializable

   

5. abstract class Cursor extends GenericCursor[Cursor]

   

   A zipper that represents a position in a JSON value and supports navigation around the JSON value.

   A zipper that represents a position in a JSON value and supports navigation around the JSON value.

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

   See also

   GenericCursor

6. sealed abstract class CursorOp extends Product with Serializable

   

7. trait Decoder[A] extends Serializable

   

8. sealed abstract class DecodingFailure extends Error

   

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

9. trait Encoder[A] extends Serializable

   

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

10. sealed abstract class Error extends Exception

    

    The base exception type for both decoding and parsing errors.

11. 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.

12. abstract class GenericCursor[C <: GenericCursor[C]] 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.

    circe includes three kinds of cursors. Cursor is the simplest: it doesn't keep track of its history. HCursor is a cursor that does keep track of its history, but does not represent the possibility that a navigation or modification operation has failed. ACursor is the richest cursor, since it both tracks history through an underlying HCursor and can represent failed operations.

    GenericCursor is an abstraction over these three types, and it has several abstract type members that are required in order to represent the different roles of the three cursor types. Self is simply the specific type of the cursor, Focus is a type constructor that represents the context in which the focus is available, Result is the type that is returned by all navigation and modification operations, and M is a type class that includes the operations that we need for withFocusM.

13. sealed abstract class HCursor extends GenericCursor[HCursor]

    

    A cursor that tracks the history of operations performed with it.

    A cursor that tracks the history of operations performed with it.

    See also

    GenericCursor

14. sealed abstract class HistoryOp extends Product with Serializable

    

15. sealed abstract class Json extends Product with Serializable

    

    A data type representing possible JSON values.

16. sealed abstract class JsonNumber extends Serializable

    

    A JSON number with optimization by cases.

17. sealed abstract class JsonObject extends Serializable

    

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

18. abstract class 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.

19. abstract class 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 resuling JSON object may have fewer fields than the original map.

20. trait ObjectEncoder[A] extends RootEncoder[A]

    

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

21. trait Parser extends Serializable

    

22. 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.

23. final case class Printer(preserveOrder: Boolean, dropNullKeys: 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 = "") extends Serializable with Product

    

    A pretty-printer for JSON values.

    A pretty-printer for JSON values.

    preserveOrder

    Determines if field ordering should be preserved.

    dropNullKeys

    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.

24. trait RootEncoder[A] extends Encoder[A]

    

    A subtype of Encoder that statically verifies that the instance encodes either a JSON array or an object.