core

Type Members

trait JsonCodec[A] extends JsonValueCodec[A] with JsonKeyCodec[A]
trait JsonKeyCodec[A] extends AnyRef
class JsonParseException extends RuntimeException
final class JsonReader extends AnyRef
trait JsonValueCodec[A] extends AnyRef
final class JsonWriter extends AnyRef
case class ReaderConfig(throwParseExceptionWithStackTrace: Boolean = false, appendHexDumpToParseException: Boolean = true, preferredBufSize: Int = 16384, preferredCharBufSize: Int = 2048) extends Product with 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 created on the reader instantiation and reused in runtime for parsing of messages.
Configuration for com.github.plokhotnyuk.jsoniter_scala.core.JsonReader that contains flags for tuning of parsing exceptions and preferred sizes for internal buffers that 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 char buffer to reduce allocation rate of grown and then reduced buffers when lot of large strings with length greater than 2K need to be parsed
- increase preferred size of an internal byte buffer for parsing from java.io.InputStream to reduce allocation rate of grown and then reduced buffers when during parsing of large ADT instances (>16Kb) the discriminator field does not appear in the beginning of the JSON object
throwParseExceptionWithStackTrace
a flag that allows to turn on a stack traces for debugging purposes in development
appendHexDumpToParseException
a flag that allows to turn off hex dumping of affected by error part of an internal byte buffer
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
class UnsafeUtils extends AnyRef
case class WriterConfig(indentionStep: Int = 0, escapeUnicode: Boolean = false, preferredBufSize: Int = 16384) extends Product with 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 created on the writer instantiation and reused in runtime for serialization of messages using java.io.OutputStream.
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 created on the writer instantiation and reused in runtime for serialization of messages using java.io.OutputStream.
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 lot of large (>16Kb) scala.math.BigDecimal, scala.math.BigInt or others non escaped ASCII strings written using JsonWriter.writeNonEscapedAsciiKey or JsonWriter.writeNonEscapedAsciiVal
indentionStep
a size of indention for pretty-printed formatting or 0 for compact output
escapeUnicode
a flag to turn on hexadecimal escaping of all non-ASCII chars
preferredBufSize
a preferred size (in bytes) of an internal byte buffer when writing to java.io.OutputStream

Value Members

object JsonReader
object JsonWriter
final def readFromArray[A](buf: Array[Byte], config: ReaderConfig = readerConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type with specified parsing options.
Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type with specified parsing options.
A
type of the value to parse
buf
the byte array to parse from
config
a parsing configuration
codec
a codec for the given A type
returns
a successfully parsed value

Exceptions thrown
JsonParseException 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
NullPointerException if the codec, buf or config is null
final def readFromStream[A](in: InputStream, config: ReaderConfig = 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.
A
type of the value to parse
in
the input stream to parse from
config
a parsing configuration
codec
a codec for the given A type
returns
a successfully parsed value

Exceptions thrown
JsonParseException 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
NullPointerException if the codec, in or config is null
final def readFromSubArray[A](buf: Array[Byte], from: Int, to: Int, config: ReaderConfig = readerConfig)(implicit codec: JsonValueCodec[A]): A

Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type with specified parsing options or with defaults that maximize description of error.
Deserialize JSON content encoded in UTF-8 from a byte array into a value of given A type with specified parsing options or with defaults that maximize description of error.
A
type of the value to parse
buf
the byte array to parse from
from
the start position of the provided byte array
to
the position of end of input in the provided byte array
config
a parsing configuration
codec
a codec for the given A type
returns
a successfully parsed value

Exceptions thrown
ArrayIndexOutOfBoundsException if the to is greater than buf length or negative, or from is greater than to or negative
JsonParseException 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
NullPointerException if the codec, buf or config is null
final def scanJsonArrayFromStream[A](in: InputStream, config: ReaderConfig = 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.
A
type of the value to parse
in
the input stream to parse from
config
a parsing configuration
f
a consumer of values, that returns true to continue scanning or false to complete it
codec
a codec for the given A type
returns
a successfully parsed value

Exceptions thrown
JsonParseException 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
NullPointerException if the codec, in or config is null
Throwable if some error was thrown by f() call
final def scanJsonValuesFromStream[A](in: InputStream, config: ReaderConfig = 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.
A
type of the value to parse
in
the input stream to parse from
config
a parsing configuration
f
a consumer of values, that returns true to continue scanning or false to complete it
codec
a codec for the given A type
returns
a successfully parsed value

Exceptions thrown
JsonParseException 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
NullPointerException if the codec, in or config is null
Throwable if some error was thrown by f() call
final def writeToArray[A](x: A, config: WriterConfig = 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, that specified by provided configuration options.
Serialize the x argument to a new allocated instance of byte array in UTF-8 encoding of JSON format, that specified by provided configuration options.
A
type of value to serialize
x
the value to serialize
config
a serialization configuration
codec
a codec for the given value
returns
a byte array with x serialized to JSON

Exceptions thrown
NullPointerException if the codec or config is null
final def writeToPreallocatedArray[A](x: A, buf: Array[Byte], from: Int, config: WriterConfig = writerConfig)(implicit codec: JsonValueCodec[A]): Int

Serialize the x argument to the given instance of byte array in UTF-8 encoding of JSON format that specified by provided configuration options or defaults that minimizes output size & time to serialize.
Serialize the x argument to the given instance of byte array in UTF-8 encoding of JSON format that specified by provided configuration options or defaults that minimizes output size & time to serialize.
A
type of value to serialize
x
the value to serialize
buf
a byte array where the value should be serialized
from
a position in the byte array from which serialization of the value should start
config
a serialization configuration
codec
a codec for the given value
returns
number of next position after last byte serialized to buf

Exceptions thrown
ArrayIndexOutOfBoundsException if the from is greater than buf length or negative, or buf length was exceeded during serialization
NullPointerException if the codec, buf or config is null
final def writeToStream[A](x: A, out: OutputStream, config: WriterConfig = writerConfig)(implicit codec: JsonValueCodec[A]): Unit

Serialize the x argument to the provided output stream in UTF-8 encoding of JSON format that specified by provided configuration options.
Serialize the x argument to the provided output stream in UTF-8 encoding of JSON format that specified by provided configuration options.
A
type of value to serialize
x
the value to serialize
out
an output stream to serialize into
config
a serialization configuration
codec
a codec for the given value

Exceptions thrown
NullPointerException if the codec, out or config is null

package core

Type Members

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

trait JsonKeyCodec[A] extends AnyRef

class JsonParseException extends RuntimeException

final class JsonReader extends AnyRef

trait JsonValueCodec[A] extends AnyRef

final class JsonWriter extends AnyRef

case class ReaderConfig(throwParseExceptionWithStackTrace: Boolean = false, appendHexDumpToParseException: Boolean = true, preferredBufSize: Int = 16384, preferredCharBufSize: Int = 2048) extends Product with Serializable

class UnsafeUtils extends AnyRef

case class WriterConfig(indentionStep: Int = 0, escapeUnicode: Boolean = false, preferredBufSize: Int = 16384) extends Product with Serializable

Value Members

object JsonReader

object JsonWriter

final def readFromArray[A](buf: Array[Byte], config: ReaderConfig = readerConfig)(implicit codec: JsonValueCodec[A]): A

final def readFromStream[A](in: InputStream, config: ReaderConfig = readerConfig)(implicit codec: JsonValueCodec[A]): A

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

final def scanJsonArrayFromStream[A](in: InputStream, config: ReaderConfig = readerConfig)(f: (A) ⇒ Boolean)(implicit codec: JsonValueCodec[A]): Unit

final def scanJsonValuesFromStream[A](in: InputStream, config: ReaderConfig = readerConfig)(f: (A) ⇒ Boolean)(implicit codec: JsonValueCodec[A]): Unit

final def writeToArray[A](x: A, config: WriterConfig = writerConfig)(implicit codec: JsonValueCodec[A]): Array[Byte]

final def writeToPreallocatedArray[A](x: A, buf: Array[Byte], from: Int, config: WriterConfig = writerConfig)(implicit codec: JsonValueCodec[A]): Int

final def writeToStream[A](x: A, out: OutputStream, config: WriterConfig = writerConfig)(implicit codec: JsonValueCodec[A]): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped