Circe core
0.14.4
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
Circe core/io.circe/Json

Json

io.circe.Json
See theJson companion object
sealed abstract class Json extends Product with Serializable

A data type representing possible JSON values.

Attributes

Companion:
object
Source:
Json.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

def asArray: Option[Vector[Json]]

Attributes

Source:
Json.scala
def asBoolean: Option[Boolean]

Attributes

Source:
Json.scala
def asNull: Option[Unit]

Attributes

Source:
Json.scala
def asNumber: Option[JsonNumber]

Attributes

Source:
Json.scala
def asObject: Option[JsonObject]

Attributes

Source:
Json.scala
def asString: Option[String]

Attributes

Source:
Json.scala
def foldWith[X](folder: Folder[X]): X

Reduce this JSON value with the given Json.Folder.

Reduce this JSON value with the given Json.Folder.

Attributes

Source:
Json.scala
def hashCode(): Int

Use implementations provided by case classes.

Use implementations provided by case classes.

Attributes

Source:
Json.scala
def isArray: Boolean

Attributes

Source:
Json.scala
def isBoolean: Boolean

Attributes

Source:
Json.scala
def isNull: Boolean

Attributes

Source:
Json.scala
def isNumber: Boolean

Attributes

Source:
Json.scala
def isObject: Boolean

Attributes

Source:
Json.scala
def isString: Boolean

Attributes

Source:
Json.scala
def mapArray(f: Vector[Json] => Vector[Json]): Json

Attributes

Source:
Json.scala
def mapBoolean(f: Boolean => Boolean): Json

Attributes

Source:
Json.scala
def mapNumber(f: JsonNumber => JsonNumber): Json

Attributes

Source:
Json.scala
def mapObject(f: JsonObject => JsonObject): Json

Attributes

Source:
Json.scala
def mapString(f: String => String): Json

Attributes

Source:
Json.scala
def withArray(f: Vector[Json] => Json): Json

Attributes

Source:
Json.scala
def withBoolean(f: Boolean => Json): Json

Attributes

Source:
Json.scala
def withNull(f: => Json): Json

Attributes

Source:
Json.scala
def withNumber(f: JsonNumber => Json): Json

Attributes

Source:
Json.scala
def withObject(f: JsonObject => Json): Json

Attributes

Source:
Json.scala
def withString(f: String => Json): Json

Attributes

Source:
Json.scala

Concrete methods

final def \\(key: String): List[Json]

Attributes

Source:
Json.scala
final def arrayOrObject[X](or: => X, jsonArray: Vector[Json] => X, jsonObject: JsonObject => X): X

Run on an array or object or return the given default.

Run on an array or object or return the given default.

Attributes

Source:
Json.scala
final def as[A](implicit d: Decoder[A]): Result[A]

Attempts to decode this JSON value to another data type.

Attempts to decode this JSON value to another data type.

Attributes

Source:
Json.scala
final def asAccumulating[A](implicit d: Decoder[A]): AccumulatingResult[A]

Attempts to decode this JSON value to another data type, accumulating failures.

Attempts to decode this JSON value to another data type, accumulating failures.

Attributes

Source:
Json.scala
def deepDropNullValues: Json

Drop the entries with a null value if this is an object or array.

Drop the entries with a null value if this is an object or array.

Attributes

Source:
Json.scala
def deepMerge(that: Json): Json

Perform a deep merge of this JSON value with another JSON value.

Perform a deep merge of this JSON value with another JSON value.

Objects are merged by key, values from the argument JSON take precedence over values from this JSON. Nested objects are recursed.

Null, Array, Boolean, String and Number are treated as values, and values from the argument JSON completely replace values from this JSON.

Attributes

Source:
Json.scala
def dropEmptyValues: Json

Drop the entries with an empty value if this is an array or object.

Drop the entries with an empty value if this is an array or object.

Note that this does not apply recursively.

Attributes

Source:
Json.scala
def dropNullValues: Json

Drop the entries with a null value if this is an object.

Drop the entries with a null value if this is an object.

Note that this does not apply recursively.

Attributes

Source:
Json.scala
final override def equals(that: Any): Boolean

Universal equality derived from our type-safe equality.

Universal equality derived from our type-safe equality.

Attributes

Definition Classes
Equals -> Any
Source:
Json.scala
final def findAllByKey(key: String): List[Json]

Recursively return all values matching the specified key.

Recursively return all values matching the specified key.

The Play docs, from which this method was inspired, reads: "Lookup for fieldName in the current object and all descendants."

Attributes

Source:
Json.scala
final def fold[X](jsonNull: => X, jsonBoolean: Boolean => X, jsonNumber: JsonNumber => X, jsonString: String => X, jsonArray: Vector[Json] => X, jsonObject: JsonObject => X): X

The catamorphism for the JSON value data type.

The catamorphism for the JSON value data type.

Attributes

Source:
Json.scala
final def hcursor: HCursor

Construct a successful cursor from this JSON value.

Construct a successful cursor from this JSON value.

Attributes

Source:
Json.scala
final def name: String

The name of the type of the JSON value.

The name of the type of the JSON value.

Attributes

Source:
Json.scala
final def noSpaces: String

Pretty-print this JSON value to a string with no spaces.

Pretty-print this JSON value to a string with no spaces.

Attributes

Source:
Json.scala
final def noSpacesSortKeys: String

Pretty-print this JSON value to a string with no spaces, with object keys sorted alphabetically.

Pretty-print this JSON value to a string with no spaces, with object keys sorted alphabetically.

Attributes

Source:
Json.scala
final def printWith(p: Printer): String

Pretty-print this JSON value to a string using the given pretty-printer.

Pretty-print this JSON value to a string using the given pretty-printer.

Attributes

Source:
Json.scala
final def spaces2: String

Pretty-print this JSON value to a string indentation of two spaces.

Pretty-print this JSON value to a string indentation of two spaces.

Attributes

Source:
Json.scala
final def spaces2SortKeys: String

Pretty-print this JSON value to a string indentation of two spaces, with object keys sorted alphabetically.

Pretty-print this JSON value to a string indentation of two spaces, with object keys sorted alphabetically.

Attributes

Source:
Json.scala
final def spaces4: String

Pretty-print this JSON value to a string indentation of four spaces.

Pretty-print this JSON value to a string indentation of four spaces.

Attributes

Source:
Json.scala
final def spaces4SortKeys: String

Pretty-print this JSON value to a string indentation of four spaces, with object keys sorted alphabetically.

Pretty-print this JSON value to a string indentation of four spaces, with object keys sorted alphabetically.

Attributes

Source:
Json.scala
final override def toString: String

Compute a String representation for this JSON value.

Compute a String representation for this JSON value.

Attributes

Definition Classes
Any
Source:
Json.scala

Inherited methods

def canEqual(that: Any): Boolean

Attributes

Inherited from:
Equals
def productArity: Int

Attributes

Inherited from:
Product
def productElement(n: Int): Any

Attributes

Inherited from:
Product
def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def productPrefix: String

Attributes

Inherited from:
Product
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL