ReaderConfig

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

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Known Subclasses

ReaderConfig

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val appendHexDumpToParseException: Boolean

a flag that allows to turn off hex dumping of affected by error part of an internal byte buffer
final def asInstanceOf[T0]: T0

Definition Classes
Any
val checkForEndOfInput: Boolean

a flag to check and raise an error if some non whitespace bytes will be detected after successful parsing of the value
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val hexDumpSize: Int

a size of the hex dump in 16-byte lines before and after the 16-byte line where an error occurs
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val preferredBufSize: Int

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

a preferred size (in chars) of an internal char buffer for parsing of string values
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val throwReaderExceptionWithStackTrace: Boolean

a flag that allows to turn on a stack traces for debugging purposes in development
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withAppendHexDumpToParseException(appendHexDumpToParseException: Boolean): ReaderConfig
def withCheckForEndOfInput(checkForEndOfInput: Boolean): ReaderConfig
def withHexDumpSize(hexDumpSize: Int): ReaderConfig
def withPreferredBufSize(preferredBufSize: Int): ReaderConfig
def withPreferredCharBufSize(preferredCharBufSize: Int): ReaderConfig
def withThrowReaderExceptionWithStackTrace(throwReaderExceptionWithStackTrace: Boolean): ReaderConfig

Related Docs: object ReaderConfig | package core

class ReaderConfig extends Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val appendHexDumpToParseException: Boolean

final def asInstanceOf[T0]: T0

val checkForEndOfInput: Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val hexDumpSize: Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val preferredBufSize: Int

val preferredCharBufSize: Int

final def synchronized[T0](arg0: ⇒ T0): T0

val throwReaderExceptionWithStackTrace: Boolean

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withAppendHexDumpToParseException(appendHexDumpToParseException: Boolean): ReaderConfig

def withCheckForEndOfInput(checkForEndOfInput: Boolean): ReaderConfig

def withHexDumpSize(hexDumpSize: Int): ReaderConfig

def withPreferredBufSize(preferredBufSize: Int): ReaderConfig

def withPreferredCharBufSize(preferredCharBufSize: Int): ReaderConfig

def withThrowReaderExceptionWithStackTrace(throwReaderExceptionWithStackTrace: Boolean): ReaderConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped