package circe
- Alphabetic
- By Inheritance
- circe
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
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
- sealed trait AccumulatingDecoder [A] extends Serializable
-
trait
ArrayEncoder
[A] extends RootEncoder[A]
A type class that provides a conversion from a value of type
A
to a JSON array. - sealed abstract class Context extends Serializable
-
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 withwithFocus
or changed using the navigation methodsleft
,right
, etc.- See also
- sealed abstract class CursorOp extends Product with Serializable
- trait Decoder [A] extends Serializable
-
sealed abstract
class
DecodingFailure
extends Error
An exception representing a decoding failure and (lazily) capturing the decoding history resulting in the failure.
-
trait
Encoder
[A] extends Serializable
A type class that provides a conversion from a value of type
A
to a Json value. -
sealed abstract
class
Error
extends Exception
The base exception type for both decoding and parsing errors.
-
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.
-
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 withwithFocus
or changed using navigation methods likeleft
andright
.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, andM
is a type class that includes the operations that we need forwithFocusM
. -
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
- sealed abstract class HistoryOp extends Product with Serializable
-
sealed abstract
class
Json
extends Product with Serializable
A data type representing possible JSON values.
-
sealed abstract
class
JsonNumber
extends Serializable
A JSON number with optimization by cases.
-
sealed abstract
class
JsonObject
extends Serializable
A mapping from keys to JSON values that maintains insertion order.
-
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
. -
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.
-
trait
ObjectEncoder
[A] extends RootEncoder[A]
A type class that provides a conversion from a value of type
A
to a JsonObject. - trait Parser extends Serializable
-
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.
-
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.
-
trait
RootEncoder
[A] extends Encoder[A]
A subtype of
Encoder
that statically verifies that the instance encodes either a JSON array or an object.
Value Members
- object ACursor extends Serializable
- object AccumulatingDecoder extends Serializable
- object ArrayEncoder extends Serializable
- object Context extends Serializable
- object Cursor extends Serializable
- object CursorOp extends Serializable
-
object
Decoder
extends TupleDecoders with ProductDecoders with LowPriorityDecoders with Serializable
Utilities and instances for Decoder.
- object DecodingFailure extends Serializable
-
object
Encoder
extends TupleEncoders with ProductEncoders with MidPriorityEncoders with Serializable
Utilities and instances for Encoder.
- object Error extends Serializable
- object HCursor extends Serializable
- object HistoryOp extends Serializable
- object Json extends Serializable
-
object
JsonNumber
extends Serializable
Constructors, type class instances, and other utilities for JsonNumber.
-
object
JsonObject
extends Serializable
Constructors, type class instances, and other utilities for JsonObject.
- object KeyDecoder extends Serializable
- object KeyEncoder extends Serializable
- object ObjectEncoder extends LowPriorityObjectEncoders with Serializable
- object ParsingFailure extends Serializable
- object Printer extends Serializable
- object RootEncoder extends LowPriorityRootEncoders with Serializable
-
object
disjunctionCodecs
Decoder and Encoder instances for disjunction types with reasonable names for the sides.