jsoniter-scala-core/com.github.plokhotnyuk.jsoniter_scala.core

com.github.plokhotnyuk.jsoniter_scala.core

package com.github.plokhotnyuk.jsoniter_scala.core

Type members

Classlikes

trait JsonCodec[@specialized A] extends JsonValueCodec[A] with JsonKeyCodec[A]

A JsonCodec[A] instance is a universal codec for JSON values and keys.

A JsonCodec[A] instance is a universal codec for JSON values and keys.

trait JsonKeyCodec[@specialized A] extends Serializable

A JsonKeyCodec[A] instance has the ability to decode and encode JSON keys to/from values of type A, potentially failing with an error if the JSON input is not a key or does not encode a value of the given type or A cannot be encoded properly according to RFC-8259 requirements.

A JsonKeyCodec[A] instance has the ability to decode and encode JSON keys to/from values of type A, potentially failing with an error if the JSON input is not a key or does not encode a value of the given type or A cannot be encoded properly according to RFC-8259 requirements.

final class JsonReader
Companion:
object
object JsonReader
Companion:
class
class JsonReaderException extends RuntimeException
trait JsonValueCodec[@specialized A] extends Serializable

A JsonValueCodec[A] instance has the ability to decode and encode JSON values to/from values of type A, potentially failing with an error if the JSON content does not encode a value of the given type or A cannot be encoded properly according to RFC-8259 requirements.

A JsonValueCodec[A] instance has the ability to decode and encode JSON values to/from values of type A, potentially failing with an error if the JSON content does not encode a value of the given type or A cannot be encoded properly according to RFC-8259 requirements.

final class JsonWriter
Companion:
object
object JsonWriter
Companion:
class
class JsonWriterException extends RuntimeException
class ReaderConfig extends Serializable

Configuration for com.github.plokhotnyuk.jsoniter_scala.core.JsonReader that contains flags for tuning of parsing exceptions and preferred sizes for internal buffers that are created on the reader instantiation and reused in runtime for parsing of messages.
All configuration params already initialized by recommended default values, but in some cases they should be altered for performance reasons:

Configuration for com.github.plokhotnyuk.jsoniter_scala.core.JsonReader that contains flags for tuning of parsing exceptions and preferred sizes for internal buffers that are created on the reader instantiation and reused in runtime for parsing of messages.
All configuration params already initialized by recommended default values, but in some cases they should be altered for performance reasons:

  • turn off stack traces for parsing exceptions to greatly reduce impact on performance for cases when exceptions can be not exceptional (e.g. under DoS attacks over open to the world systems), see more details here: https://shipilev.net/blog/2014/exceptional-performance/

  • turn off appending of hex dump to minimize length of exception message

  • increase preferred size of an internal byte buffer for parsing from java.io.InputStream or java.nio.DirectByteBuffer to reduce allocation rate of grown and then reduced buffers during parsing of large (>16Kb) numbers (including stringified), raw values, or ADT instances with the discriminator field doesn't appear in the beginning of the JSON object

  • increase preferred size of an internal char buffer to reduce allocation rate of grown and then reduced buffers when large (>4Kb) string instances need to be parsed including those one which use Base16 or Base64 encodings

Value parameters:
appendHexDumpToParseException

a flag that allows to turn off hex dumping of affected by error part of an internal byte buffer

checkForEndOfInput

a flag to check and raise an error if some non whitespace bytes will be detected after successful parsing of the value

hexDumpSize

a size of the hex dump in 16-byte lines before and after the 16-byte line where an error occurs

preferredBufSize

a preferred size (in bytes) of an internal byte buffer when parsing from java.io.InputStream

preferredCharBufSize

a preferred size (in chars) of an internal char buffer for parsing of string values

throwReaderExceptionWithStackTrace

a flag that allows to turn on a stack traces for debugging purposes in development

Companion:
object
object ReaderConfig extends ReaderConfig
Companion:
class
class WriterConfig extends Serializable

Configuration for com.github.plokhotnyuk.jsoniter_scala.core.JsonWriter that contains params for formatting of output JSON and for tuning of preferred size for internal byte buffer that is created on the writer instantiation and reused in runtime for serialization of messages using java.io.OutputStream or java.nio.DirectByteBuffer.
All configuration params already initialized to default values, but in some cases they should be altered:

Configuration for com.github.plokhotnyuk.jsoniter_scala.core.JsonWriter that contains params for formatting of output JSON and for tuning of preferred size for internal byte buffer that is created on the writer instantiation and reused in runtime for serialization of messages using java.io.OutputStream or java.nio.DirectByteBuffer.
All configuration params already initialized to default values, but in some cases they should be altered:

  • turn on pretty printing by specifying of indention step that is greater than 0

  • turn on escaping of Unicode characters to serialize with only ASCII characters

  • increase preferred size of an internal byte buffer to reduce allocation rate of grown and then reduced buffers when writing to java.io.OutputStream or java.nio.DirectByteBuffer lot of large (>16Kb) scala.math.BigDecimal, scala.math.BigInt or other non escaped ASCII strings written using JsonWriter.writeNonEscapedAsciiKey or JsonWriter.writeNonEscapedAsciiVal

Value parameters:
escapeUnicode

a flag to turn on hexadecimal escaping of all non-ASCII chars

indentionStep

a size of indention for pretty-printed formatting or 0 for compact output

preferredBufSize

a preferred size (in bytes) of an internal byte buffer when writing to java.io.OutputStream or java.nio.DirectByteBuffer

throwWriterExceptionWithStackTrace

a flag that allows to turn on a stack traces for debugging purposes in development

Companion:
object
object WriterConfig extends WriterConfig
Companion:
class

Value members

Concrete methods

def readFromArray[@specialized A](buf: Array[Byte], config: ReaderConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type.

Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type.

Type parameters:
A

type of the value to parse

Value parameters:
buf

the byte array to parse from

codec

a codec for the given A type

config

a parsing configuration

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains malformed UTF-8 bytes, invalid JSON content or the input JSON structure does not match structure that expected for result type, also in case if end of input is detected while some input bytes are expected

java.lang.NullPointerException

if any of codec, buf or config is null

def readFromByteBuffer[@specialized A](bbuf: ByteBuffer, config: ReaderConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content encoded in UTF-8 from a byte buffer into a value of given A type.

Deserialize JSON content encoded in UTF-8 from a byte buffer into a value of given A type.

Parsing will start from the current position and will continue until the limit of the provided byte buffer or the value will be parsed before reaching of the limit. In any case the buffer position will be set to the next position after the last read byte.

Type parameters:
A

type of the value to parse

Value parameters:
bbuf

the byte buffer which will be parsed

codec

a codec for the given A type

config

a parsing configuration

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains malformed UTF-8 bytes, invalid JSON content or the input JSON structure does not match structure that expected for the result type, also in case if end of input is detected while some input bytes are expected

java.lang.NullPointerException

if any of codec, bbuf or config is null

def readFromStream[@specialized A](in: InputStream, config: ReaderConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content encoded in UTF-8 from an input stream into a value of given A type.

Deserialize JSON content encoded in UTF-8 from an input stream into a value of given A type.

Type parameters:
A

type of the value to parse

Value parameters:
codec

a codec for the given A type

config

a parsing configuration

in

the input stream to parse from

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains malformed UTF-8 bytes, invalid JSON content or the input JSON structure does not match structure that expected for result type, also if a low-level I/O problem (unexpected end-of-input, network error) occurs while some input bytes are expected

java.lang.NullPointerException

if any of codec, in or config is null

def readFromString[A](s: String, config: ReaderConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content from a string into a value of given A type.

Deserialize JSON content from a string into a value of given A type.

Type parameters:
A

type of the value to parse

Value parameters:
codec

a codec for the given A type

config

a parsing configuration

s

a value of string which will be parsed

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains invalid JSON content or the input JSON structure does not match structure that expected for the result type, also in case if end of input is detected while some input characters are expected

java.lang.NullPointerException

if the codec, s or config is null

def readFromStringReentrant[A](s: String, config: ReaderConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content from a string into a value of given A type.

Deserialize JSON content from a string into a value of given A type.

While it is less efficient than parsing from a string using pooled readers but it can be safely used internally in custom codecs when previous call of this method is not finished in this thread.

Type parameters:
A

type of the value to parse

Value parameters:
codec

a codec for the given A type

config

a parsing configuration

s

a value of string which will be parsed

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains invalid JSON content or the input JSON structure does not match structure that expected for the result type, also in case if end of input is detected while some input characters are expected

java.lang.NullPointerException

if any of codec, s or config is null

def readFromSubArray[@specialized A](buf: Array[Byte], from: Int, to: Int, config: ReaderConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type.

Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type.

Type parameters:
A

type of the value to parse

Value parameters:
buf

the byte array to parse from

codec

a codec for the given A type

config

a parsing configuration

from

the start position of the provided byte array

to

the position of end of input in the provided byte array

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains malformed UTF-8 bytes, invalid JSON content or the input JSON structure does not match structure that expected for result type, also in case if end of input is detected while some input bytes are expected

java.lang.ArrayIndexOutOfBoundsException

if the to is greater than buf length or negative, or from is greater than to or negative

java.lang.NullPointerException

if any of codec, buf or config is null

def scanJsonArrayFromStream[@specialized A](in: InputStream, config: ReaderConfig)(f: A => Boolean)(implicit codec: JsonValueCodec[A]): Unit

Deserialize JSON array encoded in UTF-8 from an input stream into its values of given A type.

Deserialize JSON array encoded in UTF-8 from an input stream into its values of given A type.

All parsed values will be passed to consuming function f.

Type parameters:
A

type of the value to parse

Value parameters:
codec

a codec for the given A type

config

a parsing configuration

f

a consumer of values, that returns true to continue scanning or false to complete it

in

the input stream to parse from

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains malformed UTF-8 bytes, invalid JSON content or the input JSON structure does not match structure that expected for result type, also if a low-level I/O problem (unexpected end-of-input, network error) occurs while some input bytes are expected

java.lang.NullPointerException

if any of codec, in or config is null

java.lang.Throwable

if some error was thrown by f() call

def scanJsonValuesFromStream[@specialized A](in: InputStream, config: ReaderConfig)(f: A => Boolean)(implicit codec: JsonValueCodec[A]): Unit

Deserialize JSON of streaming values encoded in UTF-8 from an input stream into values of given A type.

Deserialize JSON of streaming values encoded in UTF-8 from an input stream into values of given A type.

All parsed values will be passed to consuming function f.

Type parameters:
A

type of the value to parse

Value parameters:
codec

a codec for the given A type

config

a parsing configuration

f

a consumer of values, that returns true to continue scanning or false to complete it

in

the input stream to parse from

Returns:

a successfully parsed value

Throws:
JsonReaderException

if underlying input contains malformed UTF-8 bytes, invalid JSON content or the input JSON structure does not match structure that expected for result type, also if a low-level I/O problem (unexpected end-of-input, network error) occurs while some input bytes are expected

java.lang.NullPointerException

if any of codec, in or config is null

java.lang.Throwable

if some error was thrown by f() call

def writeToArray[@specialized A](x: A, config: WriterConfig)(implicit codec: JsonValueCodec[A]): Array[Byte]

Serialize the x argument to a new allocated instance of byte array in UTF-8 encoding of JSON format.

Serialize the x argument to a new allocated instance of byte array in UTF-8 encoding of JSON format.

Type parameters:
A

type of value to serialize

Value parameters:
codec

a codec for the given value

config

a serialization configuration

x

the value to serialize

Returns:

a byte array with x serialized to JSON

Throws:
JsonWriterException

if the value to serialize contains strings, double or float values which cannot be properly encoded

java.lang.NullPointerException

if any of x, codec or config is null

def writeToByteBuffer[@specialized A](x: A, bbuf: ByteBuffer, config: WriterConfig)(implicit codec: JsonValueCodec[A]): Unit

Serialize the x argument to the given instance of byte buffer in UTF-8 encoding of JSON format.

Serialize the x argument to the given instance of byte buffer in UTF-8 encoding of JSON format.

Serialization will start from the current position up to the provided byte buffer limit. On return the byte buffer will has position set to the next position after the last written byte.

Type parameters:
A

type of value to serialize

Value parameters:
bbuf

a byte buffer where the value should be serialized

codec

a codec for the given value

config

a serialization configuration

x

the value to serialize

Throws:
JsonWriterException

if the value to serialize contains strings, double or float values which cannot be properly encoded

java.lang.NullPointerException

if any of x, codec, bbuf or config is null

java.nio.BufferOverflowException

if the bbuf limit was exceeded during serialization

java.nio.ReadOnlyBufferException

if the bbuf is read-only

def writeToStream[@specialized A](x: A, out: OutputStream, config: WriterConfig)(implicit codec: JsonValueCodec[A]): Unit

Serialize the x argument to the provided output stream in UTF-8 encoding of JSON format.

Serialize the x argument to the provided output stream in UTF-8 encoding of JSON format.

Type parameters:
A

type of value to serialize

Value parameters:
codec

a codec for the given value

config

a serialization configuration

out

an output stream to serialize into

x

the value to serialize

Throws:
JsonWriterException

if the value to serialize contains strings, double or float values which cannot be properly encoded

java.io.IOException

if an I/O error occurs in a call to output stream

java.lang.NullPointerException

if any of x, codec, out or config is null

def writeToString[@specialized A](x: A, config: WriterConfig)(implicit codec: JsonValueCodec[A]): String

Serialize the x argument to a string in JSON format.

Serialize the x argument to a string in JSON format.

Type parameters:
A

type of value to serialize

Value parameters:
codec

a codec for the given value

config

a serialization configuration

x

the value to serialize

Returns:

a string with x serialized to JSON

Throws:
JsonWriterException

if the value to serialize contains strings, double or float values which cannot be properly encoded

java.lang.NullPointerException

if any of x, codec or config is null

def writeToStringReentrant[@specialized A](x: A, config: WriterConfig)(implicit codec: JsonValueCodec[A]): String

Serialize the x argument to a string in JSON format.

Serialize the x argument to a string in JSON format.

While it is less efficient than serialization to a string using pooled writers but it can be safely used internally in custom codecs when previous call of this method is not finished in this thread.

Type parameters:
A

type of value to serialize

Value parameters:
codec

a codec for the given value

config

a serialization configuration

x

the value to serialize

Returns:

a string with x serialized to JSON

Throws:
JsonWriterException

if the value to serialize contains strings, double or float values which cannot be properly encoded

java.lang.NullPointerException

if the codec or config is null

def writeToSubArray[@specialized A](x: A, buf: Array[Byte], from: Int, to: Int, config: WriterConfig)(implicit codec: JsonValueCodec[A]): Int

Serialize the x argument to the given instance of byte array in UTF-8 encoding of JSON format.

Serialize the x argument to the given instance of byte array in UTF-8 encoding of JSON format.

Type parameters:
A

type of value to serialize

Value parameters:
buf

a byte array where the value should be serialized

codec

a codec for the given value

config

a serialization configuration

from

a position in the byte array from which serialization of the value should start

to

an exclusive position in the byte array that limits where serialization of the value should stop

x

the value to serialize

Returns:

number of next position after last byte serialized to buf

Throws:
JsonWriterException

if the value to serialize contains strings, double or float values which cannot be properly encoded

java.lang.ArrayIndexOutOfBoundsException

if the from is greater than to or negative, if 'to' is greater than buf length or to limit was exceeded during serialization

java.lang.NullPointerException

if any of x, codec, buf or config is null