Grapple
17.0.0
API
Generated with
Grapple/grapple.json

grapple.json

package grapple.json

Members list

Packages

package grapple.json.rpc

Type members

Classlikes

object Json

Provides JSON utilities.

Provides JSON utilities.

import scala.language.implicitConversions

import grapple.json.{ *, given }

// Create JSON object
val user = Json.obj("id" -> 1000, "name" -> "lupita")

// Create JSON array
val info = Json.arr(user, "/home/lupita", 8L * 1024 * 1024 * 1024)

// Parse JSON text
val root = Json.parse("""{ "id": 0, "name": "root" }""")

case class User(id: Int, name: String)

given userOutput: JsonOutput[User] with
 def write(u: User) = Json.obj("id" -> u.id, "name" -> u.name)

// Convert value to JSON object
val nobody = Json.toJson(User(65534, "nobody"))

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Json.type
trait JsonAdapter[T] extends JsonInput[T], JsonOutput[T]

Defines JSON input and output conversions.

Defines JSON input and output conversions.

Attributes

Supertypes
trait JsonOutput[T]
trait JsonInput[T]
class Object
trait Matchable
class Any
trait JsonArray extends JsonStructure

Represents JSON array.

Represents JSON array.

Attributes

See also
Companion
object
Supertypes
trait JsonValue
class Object
trait Matchable
class Any
Known subtypes
object JsonArray

Provides JSON array factory.

Provides JSON array factory.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
JsonArray.type
class JsonArrayBuilder

Defines JSON array builder.

Defines JSON array builder.

import scala.language.implicitConversions

import grapple.json.{ *, given }

val user = JsonArrayBuilder()
 .add(1000)
 .add("lupita")
 .add(Set("lupita", "sudoer"))
 .toJsonArray()

assert { user(0).as[Int] == 1000 }
assert { user(1).as[String] == "lupita" }
assert { user(2).as[Set[String]] == Set("lupita", "sudoer") }

Attributes

See also
Supertypes
class Object
trait Matchable
class Any
case class JsonArrayError(index: Int, cause: Exception) extends JsonException

Defines JSON array error.

Defines JSON array error.

Value parameters

cause

underlying cause

index

array index

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait JsonBoolean extends JsonValue

Represents JSON boolean.

Represents JSON boolean.

Attributes

Companion
object
Supertypes
trait JsonValue
class Object
trait Matchable
class Any
Known subtypes
object False
object True
object JsonBoolean

Provides JSON boolean factory.

Provides JSON boolean factory.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class JsonException(message: String, cause: Throwable) extends RuntimeException

Defines JSON exception.

Defines JSON exception.

Value parameters

cause

underlying cause

message

detail message

Attributes

Constructor

Constructs exception with detail message and underlying cause.

Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class JsonRpcError
class ParseError
Show all
case class JsonExpectationError(expected: Class[_], actual: Class[_]) extends JsonException

Defines JSON expectation error.

Defines JSON expectation error.

Value parameters

actual

class

expected

class

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait JsonGenerator extends AutoCloseable

Defines JSON generator.

Defines JSON generator.

import java.io.StringWriter

import scala.language.implicitConversions

import grapple.json.{ *, given }

val buf = StringWriter()
val out = JsonGenerator(buf)

try
 out.writeStartObject()          // start root object
 out.write("id", 1000)
 out.write("name", "lupita")
 out.writeStartArray("groups")   // start nested array
 out.write("lupita")
 out.write("admin")
 out.write("sudoer")
 out.writeEnd()                  // end nested array
 out.writeStartObject("info")    // start nested object
 out.write("home", "/home/lupita")
 out.write("storage", "8 GiB")
 out.writeEnd()                  // end nested object
 out.writeEnd()                  // end root object
 out.flush()

 val json = Json.parse(buf.toString)
 assert { json("id") == JsonNumber(1000) }
 assert { json("name") == JsonString("lupita") }
 assert { json("groups") == Json.arr("lupita", "admin", "sudoer") }
 assert { json("info") == Json.obj("home" -> "/home/lupita", "storage" -> "8 GiB") }
finally
 out.close()

Attributes

See also
Companion
object
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
object JsonGenerator

Provides JSON generator factory.

Provides JSON generator factory.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class JsonGeneratorError(message: String) extends JsonException

Defines JSON generator error.

Defines JSON generator error.

Value parameters

message

detail message

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
@FunctionalInterface
trait JsonInput[T]

Defines JSON input conversion.

Defines JSON input conversion.

import scala.language.implicitConversions

import grapple.json.{ *, given }

case class User(id: Int, name: String)

// Define how to convert JsonValue to User
given userInput: JsonInput[User] =
 json => User(json("id"), json("name"))

val json = Json.obj("id" -> 0, "name" -> "root")
assert { json.as[User] == User(0, "root") }

Attributes

See also
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait JsonAdapter[T]
case object JsonNull extends JsonValue

Represents JSON null.

Represents JSON null.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait JsonValue
class Object
trait Matchable
class Any
Show all
Self type
JsonNull.type
sealed trait JsonNumber extends JsonValue

Represents JSON number.

Represents JSON number.

Attributes

Companion
object
Supertypes
trait JsonValue
class Object
trait Matchable
class Any
object JsonNumber

Provides JSON number factory.

Provides JSON number factory.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
JsonNumber.type
trait JsonObject extends JsonStructure

Represents JSON object.

Represents JSON object.

Attributes

See also
Companion
object
Supertypes
trait JsonValue
class Object
trait Matchable
class Any
Known subtypes
object JsonObject

Provides JSON object factory.

Provides JSON object factory.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
JsonObject.type
class JsonObjectBuilder

Defines JSON object builder.

Defines JSON object builder.

import scala.language.implicitConversions

import grapple.json.{ *, given }

val user = JsonObjectBuilder()
 .add("id", 1000)
 .add("name", "lupita")
 .add("groups", Set("lupita", "sudoer"))
 .toJsonObject()

assert { user("id").as[Int] == 1000 }
assert { user("name").as[String] == "lupita" }
assert { user("groups").as[Set[String]] == Set("lupita", "sudoer") }

Attributes

See also
Supertypes
class Object
trait Matchable
class Any
case class JsonObjectError(key: String, cause: Exception) extends JsonException

Defines JSON object error.

Defines JSON object error.

Value parameters

cause

underlying cause

key

object key

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
@FunctionalInterface
trait JsonOutput[T]

Defines JSON output conversion.

Defines JSON output conversion.

import scala.language.implicitConversions

import grapple.json.{ *, given }

case class User(id: Int, name: String)

// Define how to convert User to JsonValue
given userOutput: JsonOutput[User] =
 user => Json.obj("id" -> user.id, "name" -> user.name)

val users = Json.arr(User(0, "root"), User(1000, "lupita"))
assert { users(0) == Json.obj("id" -> 0, "name" -> "root") }
assert { users(1) == Json.obj("id" -> 1000, "name" -> "lupita") }

Attributes

See also
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait JsonAdapter[T]
trait JsonParser extends Iterator[Event], AutoCloseable

Defines JSON parser.

Defines JSON parser.

import scala.language.implicitConversions

import grapple.json.{ *, given }
import grapple.json.JsonParser.Event

val parser = JsonParser("""{ "id": 1000, "name": "lupita", "groups": ["lupita", "admin"] }""")

try
 // Get first event (start root object)
 assert { parser.next() == Event.StartObject }

 // Get key and value
 assert { parser.next() == Event.Key("id") }
 assert { parser.next() == Event.Value(1000) }

 // Get key and value
 assert { parser.next() == Event.Key("name") }
 assert { parser.next() == Event.Value("lupita") }

 // Get key and value
 assert { parser.next() == Event.Key("groups") }
 assert { parser.next() == Event.StartArray } // start nested array
 assert { parser.next() == Event.Value("lupita") }
 assert { parser.next() == Event.Value("admin") }
 assert { parser.next() == Event.EndArray }   // end nested array

 // Get final event (end root object)
 assert { parser.next() == Event.EndObject }

 // No more events
 assert { !parser.hasNext }
finally
 parser.close()

Attributes

See also
Companion
object
Supertypes
trait AutoCloseable
trait Iterator[Event]
trait IterableOnceOps[Event, Iterator, Iterator[Event]]
trait IterableOnce[Event]
class Object
trait Matchable
class Any
Show all
object JsonParser

Provides JSON parser factory and other utilities.

Provides JSON parser factory and other utilities.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
JsonParser.type
case class JsonParserError(message: String, offset: Long) extends JsonException

Defines JSON parser error.

Defines JSON parser error.

Value parameters

message

detail message

offset

character offset of parser error

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait JsonReader extends AutoCloseable

Defines JSON reader.

Defines JSON reader.

import scala.language.implicitConversions

import grapple.json.{ *, given }

val in = JsonReader("""{ "id": 1000, "name": "lupita" }""")

try
 val user = in.read()
 assert { user("id").as[Int] == 1000 }
 assert { user("name").as[String] == "lupita" }
finally
 in.close()

Attributes

See also
Companion
object
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
object JsonReader

Provides JSON reader factory.

Provides JSON reader factory.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
JsonReader.type
sealed trait JsonString extends JsonValue

Represents JSON string.

Represents JSON string.

Attributes

Companion
object
Supertypes
trait JsonValue
class Object
trait Matchable
class Any
object JsonString

Provides JSON string factory.

Provides JSON string factory.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
JsonString.type
sealed trait JsonStructure extends JsonValue

Represents JSON structure.

Represents JSON structure.

Attributes

Supertypes
trait JsonValue
class Object
trait Matchable
class Any
Known subtypes
trait JsonArray
trait JsonObject
class JsonStructureFacade extends JsonObject, JsonArray

Assumes either JSON object or JSON array.

Assumes either JSON object or JSON array.

Attributes

See also
Note

A structure facade is created by conversion only.

Supertypes
trait JsonArray
trait JsonObject
trait JsonValue
class Object
trait Matchable
class Any
Show all
sealed trait JsonValue

Represents JSON value.

Represents JSON value.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait JsonBoolean
object False
object True
object JsonNull
trait JsonNumber
trait JsonString
trait JsonArray
trait JsonObject
Show all
trait JsonWriter extends AutoCloseable

Defines JSON writer.

Defines JSON writer.

import java.io.StringWriter

import scala.language.implicitConversions

import grapple.json.{ *, given }

val buf = StringWriter()
val out = JsonWriter(buf)

try
 val user = Json.obj("id" -> 1000, "name" -> "lupita")
 out.write(user)

 val json = Json.parse(buf.toString)
 assert { json == user }
finally
 out.close()

Attributes

See also
Companion
object
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
object JsonWriter

Provides JSON writer factory.

Provides JSON writer factory.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
JsonWriter.type

Givens

Givens

given arrayJsonInput[T](using input: JsonInput[T])(using ctag: ClassTag[T]): JsonInput[Array[T]]

Converts JsonValue to Array.

Converts JsonValue to Array.

Attributes

given arrayJsonOutput[T](using output: JsonOutput[T]): JsonOutput[Array[T]]

Converts Array to JsonArray.

Converts Array to JsonArray.

Attributes

given bigDecimalJsonInput: JsonInput[BigDecimal]

Converts JsonValue to BigDecimal.

Converts JsonValue to BigDecimal.

Attributes

given bigDecimalJsonOutput: JsonOutput[BigDecimal]

Converts BigDecimal to JsonNumber.

Converts BigDecimal to JsonNumber.

Attributes

given bigIntJsonInput: JsonInput[BigInt]

Converts JsonValue to BigInt.

Converts JsonValue to BigInt.

Attributes

given bigIntJsonOutput: JsonOutput[BigInt]

Converts BigInt to JsonNumber.

Converts BigInt to JsonNumber.

Attributes

given booleanJsonInput: JsonInput[Boolean]

Converts JsonValue to Boolean.

Converts JsonValue to Boolean.

Attributes

given booleanJsonOutput: JsonOutput[Boolean]

Converts Boolean to JsonBoolean.

Converts Boolean to JsonBoolean.

Attributes

given doubleJsonInput: JsonInput[Double]

Converts JsonValue to Double.

Converts JsonValue to Double.

Attributes

given doubleJsonOutput: JsonOutput[Double]

Converts Double to JsonNumber.

Converts Double to JsonNumber.

Attributes

given eitherJsonInput[A, B](using left: JsonInput[A])(using right: JsonInput[B]): JsonInput[Either[A, B]]

Converts JsonValue to Either.

Converts JsonValue to Either.

Attributes

given eitherJsonOutput[A, B, C <: (Either)](using left: JsonOutput[A])(using right: JsonOutput[B]): JsonOutput[C[A, B]]

Converts Either to JsonValue.

Converts Either to JsonValue.

Attributes

given failureJsonOutput: JsonOutput[Failure[_]]

Converts Failure to JsonNull.

Converts Failure to JsonNull.

Attributes

given floatJsonInput: JsonInput[Float]

Converts JsonValue to Float.

Converts JsonValue to Float.

Attributes

given floatJsonOutput: JsonOutput[Float]

Converts Float to JsonNumber.

Converts Float to JsonNumber.

Attributes

given intJsonInput: JsonInput[Int]

Converts JsonValue to Int.

Converts JsonValue to Int.

Attributes

given intJsonOutput: JsonOutput[Int]

Converts Int to JsonNumber.

Converts Int to JsonNumber.

Attributes

given iterableJsonInput[T, C <: (Iterable)](using input: JsonInput[T])(using factory: Factory[T, C[T]]): JsonInput[C[T]]

Converts JsonValue to Iterable.

Converts JsonValue to Iterable.

Attributes

given iterableJsonOutput[T, C <: (Iterable)](using output: JsonOutput[T]): JsonOutput[C[T]]

Converts Iterable to JsonArray.

Converts Iterable to JsonArray.

Attributes

given jsonArrayJsonInput: JsonInput[JsonArray]

Casts JsonValue to JsonArray.

Casts JsonValue to JsonArray.

Attributes

given jsonBooleanJsonInput: JsonInput[JsonBoolean]

Casts JsonValue to JsonBoolean.

Casts JsonValue to JsonBoolean.

Attributes

given jsonFieldConversion[T](using output: JsonOutput[T]): Conversion[(String, T), (String, JsonValue)]

Converts (String, T) to (String, JsonValue).

Converts (String, T) to (String, JsonValue).

Attributes

given jsonInputConversion[T](using input: JsonInput[T]): Conversion[JsonValue, T]

Applies conversion using JsonInput.

Applies conversion using JsonInput.

Attributes

given jsonNullJsonInput: JsonInput[JsonNull.type]

Casts JsonValue to JsonNull.

Casts JsonValue to JsonNull.

Attributes

given jsonNumberJsonInput: JsonInput[JsonNumber]

Casts JsonValue to JsonNumber.

Casts JsonValue to JsonNumber.

Attributes

given jsonObjectJsonInput: JsonInput[JsonObject]

Casts JsonValue to JsonObject.

Casts JsonValue to JsonObject.

Attributes

given jsonOutputConversion[T](using output: JsonOutput[T]): Conversion[T, JsonValue]

Applies conversion using JsonOutput.

Applies conversion using JsonOutput.

Attributes

given jsonStringJsonInput: JsonInput[JsonString]

Casts JsonValue to JsonString.

Casts JsonValue to JsonString.

Attributes

given jsonStructureFacadeConversion: Conversion[JsonValue, JsonStructureFacade]

Converts JsonValue to JsonStructureFacade.

Converts JsonValue to JsonStructureFacade.

Attributes

given jsonValueJsonInput: JsonInput[JsonValue]

Returns JsonValue as is.

Returns JsonValue as is.

This instance is required to perform actions such as the following:

import scala.language.implicitConversions

import grapple.json.{ Json, JsonValue, given }

val json = Json.obj("values" -> Json.arr("abc", 123, true))

// Requires jsonValueJsonInput
val list = json("values").as[List[JsonValue]]

Attributes

given leftJsonOutput[T](using output: JsonOutput[T]): JsonOutput[Left[T, _]]

Converts Left to JsonValue.

Converts Left to JsonValue.

Attributes

given longJsonInput: JsonInput[Long]

Converts JsonValue to Long.

Converts JsonValue to Long.

Attributes

given longJsonOutput: JsonOutput[Long]

Converts Long to JsonNumber.

Converts Long to JsonNumber.

Attributes

given mapJsonInput[T, C <: ([T] =>> Map[String, T])](using input: JsonInput[T])(using factory: Factory[(String, T), C[T]]): JsonInput[C[T]]

Converts JsonValue to Map.

Converts JsonValue to Map.

Attributes

given mapJsonOutput[T, C <: ([T] =>> Map[String, T])](using output: JsonOutput[T]): JsonOutput[C[T]]

Converts Map to JsonObject.

Converts Map to JsonObject.

Attributes

given noneJsonOutput: JsonOutput[None.type]

Converts None to JsonNull.

Converts None to JsonNull.

Attributes

given optionJsonInput[T](using input: JsonInput[T]): JsonInput[Option[T]]
given optionJsonOutput[T, C <: (Option)](using output: JsonOutput[T]): JsonOutput[C[T]]

Converts Some to JsonValue or returns JsonNull if None.

Converts Some to JsonValue or returns JsonNull if None.

Attributes

given rightJsonOutput[T](using output: JsonOutput[T]): JsonOutput[Right[_, T]]

Converts Right to JsonValue.

Converts Right to JsonValue.

Attributes

given stringJsonInput: JsonInput[String]

Converts JsonValue to String.

Converts JsonValue to String.

Attributes

given stringJsonOutput: JsonOutput[String]

Converts String to JsonString.

Converts String to JsonString.

Attributes

given tryJsonInput[T](using input: JsonInput[T]): JsonInput[Try[T]]

Converts JsonValue to Try.

Converts JsonValue to Try.

Attributes

given tryJsonOutput[T, C <: (Try)](using output: JsonOutput[T]): JsonOutput[C[T]]

Converts Success to JsonValue or returns JsonNull if Failure.

Converts Success to JsonValue or returns JsonNull if Failure.

Attributes

Extensions

Extensions

extension (json: JsonValue)
def \(key: String): JsonValue

Gets value in JSON object.

Gets value in JSON object.

Value parameters

key

object key

Attributes

Throws
JsonExpectationError

if not JsonObject

JsonObjectError

if object key does not exist

def \(index: Int): JsonValue

Gets value in JSON array.

Gets value in JSON array.

Value parameters

index

array index

Attributes

Throws
JsonArrayError

if array index is out of bounds

JsonExpectationError

if not JsonArray

def \\(key: String): Seq[JsonValue]

Collects values with given object key while traversing nested objects and arrays.

Collects values with given object key while traversing nested objects and arrays.

import grapple.json.{ Json, \\, given }

val json = Json.parse("""{
 "node": {
   "name": "localhost",
   "users": [
     { "id": 0,    "name": "root" },
     { "id": 1000, "name": "lupita"  }
   ]
 }
}""")

val names = (json \\ "name").map(_.as[String])

assert { names == Seq("localhost", "root", "lupita") }

Value parameters

key

object key

Attributes

Generated with