WriterConfig

com.github.plokhotnyuk.jsoniter_scala.core.WriterConfig
See theWriterConfig companion object
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 any type of output except pre-allocated byte arrays or heap byte buffers supplied as arguments.
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 internal buffers when serialized output size is greater than 32Kb

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 any type of output except pre-allocated byte arrays or heap byte buffers supplied as arguments

throwWriterExceptionWithStackTrace

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

Attributes

Companion
object
Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object WriterConfig.type

Members list

Value members

Concrete methods

def withEscapeUnicode(escapeUnicode: Boolean): WriterConfig
def withIndentionStep(indentionStep: Int): WriterConfig
def withPreferredBufSize(preferredBufSize: Int): WriterConfig
def withThrowWriterExceptionWithStackTrace(throwWriterExceptionWithStackTrace: Boolean): WriterConfig

Concrete fields

val escapeUnicode: Boolean
val indentionStep: Int
val preferredBufSize: Int