JsonFormat

scalapb.ujson.JsonFormat$
See theJsonFormat companion class
object JsonFormat extends JsonFormat

The default instance.

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Inherited classlikes

object Writer extends Transformer[GeneratedMessage]

Attributes

Inherited from:
JsonFormat
Graph
Supertypes
trait Transformer[GeneratedMessage]
class Object
trait Matchable
class Any

Value members

Inherited methods

def read[A <: GeneratedMessage](json: Readable)(using companion: GeneratedMessageCompanion[A]): A

Read JSON and convert it to a ScalaPB-generated message type.

Read JSON and convert it to a ScalaPB-generated message type.

The source of JSON can be anything than can be converted to a ujson.Readable type. Examples include:

  • String
  • java.io.InputStream
  • ujson.Value
  • geny.Readable

See the ujson.Readable companion object fort a list of all available implicit conversions.

Note: this method accepts input from any instance of JsonFormat, regardless of the customizations given as parameters. As such, it could technically only be defined as a global method, or part of the JsonFormat companion object. However, to keep symmetry with write methods and for usability, it is defined per-instance but calls out to the same global objects implementing the actual read functionality.

Attributes

Throws:
JsonReadException

if something went wrong reading or parsing the input JSON. The exception contains a position field, which can be used to retrieve the position in the input at which the error occurred.

Inherited from:
JsonFormat
def write(message: GeneratedMessage, indent: Int, escapeUnicode: Boolean): String

Convert a ScalaPB-generated message to its canonical JSON representation, as a string.

Convert a ScalaPB-generated message to its canonical JSON representation, as a string.

Attributes

Inherited from:
JsonFormat
def writeTo(message: GeneratedMessage, out: Writer, indent: Int, escapeUnicode: Boolean): Unit

Convert a ScalaPB-generated message to its canonical JSON representation and write it to some output writer.

Convert a ScalaPB-generated message to its canonical JSON representation and write it to some output writer.

This is faster than first creating a string and then writing it, and also materializes less intermediate datastructures in memory.

Attributes

Inherited from:
JsonFormat
def writeToByteArray(message: GeneratedMessage, indent: Int, escapeUnicode: Boolean): Array[Byte]

Convert a ScalaPB-generated message to its canonical JSON representation, as an array of bytes equivalent to its string representation.

Convert a ScalaPB-generated message to its canonical JSON representation, as an array of bytes equivalent to its string representation.

Attributes

Inherited from:
JsonFormat
def writeToJson(message: GeneratedMessage, indent: Int, escapeUnicode: Boolean): Value

Convert a ScalaPB-generated message to its canonical JSON representation, as a ujson.Value object.

Convert a ScalaPB-generated message to its canonical JSON representation, as a ujson.Value object.

Attributes

Inherited from:
JsonFormat
def writeToOutputStream(message: GeneratedMessage, out: OutputStream, indent: Int, escapeUnicode: Boolean): Unit

Convert a ScalaPB-generated message to its canonical JSON representation and write it as utf-8 bytes to an output stream.

Convert a ScalaPB-generated message to its canonical JSON representation and write it as utf-8 bytes to an output stream.

This is faster than first creating a string and then writing it, and also materializes less intermediate datastructures in memory.

Attributes

Inherited from:
JsonFormat

Inherited fields

Attributes

Inherited from:
JsonFormat

Attributes

Inherited from:
JsonFormat

Attributes

Inherited from:
JsonFormat