core
API
Generated with
core/io.bullet.borer/DecodingSetup/Api

Api

io.bullet.borer.DecodingSetup.Api
sealed trait Api[Config <: DecodingConfig] extends CommonApi[Config]

Attributes

Graph
Supertypes
trait CommonApi[Config]
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def to[T : Decoder]: Sealed[T]

Decodes an instance of T from the configured Input using the configured options.

Decodes an instance of T from the configured Input using the configured options.

Attributes

def withPrefixOnly: Api.this.type

Indicates that this decoding run is not expected to consume the complete Input.

Indicates that this decoding run is not expected to consume the complete Input.

Attributes

Inherited methods

def withConfig(config: Config): CommonApi.this.type

Configures the Config for this encoding/decoding run.

Configures the Config for this encoding/decoding run.

Attributes

Inherited from:
CommonApi
def withLogging(createLogger: LevelInfo => Logger): CommonApi.this.type

Enables logging of the encoding/decoding progress to the given Logging.Logger.

Enables logging of the encoding/decoding progress to the given Logging.Logger.

Attributes

Inherited from:
CommonApi
def withPrintLogging(maxShownByteArrayPrefixLen: Int, maxShownStringPrefixLen: Int, maxShownArrayElems: Int, maxShownMapEntries: Int, initialGutterWidth: Int, renderLevelCount: Boolean, renderEndOfInput: Boolean, renderCommas: Boolean, indentation: String, mapKeySep: String): CommonApi.this.type

Enables logging of the encoding/decoding progress to the console. Each data item that is written/received by the application is pretty printed to the console on its own line.

Enables logging of the encoding/decoding progress to the console. Each data item that is written/received by the application is pretty printed to the console on its own line.

Attributes

Inherited from:
CommonApi
def withStringLogging(stringBuilder: StringBuilder, maxShownByteArrayPrefixLen: Int, maxShownStringPrefixLen: Int, maxShownArrayElems: Int, maxShownMapEntries: Int, initialGutterWidth: Int, renderLevelCount: Boolean, renderEndOfInput: Boolean, renderCommas: Boolean, indentation: String, mapKeySep: String, lineSep: String, mapValueOnNewLine: Boolean): CommonApi.this.type

Enables logging of the encoding/decoding progress to the given JStringBuilder.

Enables logging of the encoding/decoding progress to the given JStringBuilder.

Attributes

Inherited from:
CommonApi
def withTransformerAdded(transformer: () => Config): CommonApi.this.type

Allows for injecting additional custom logic into the encoding/decoding process. Used, for example, for on-the-side Logging.

Allows for injecting additional custom logic into the encoding/decoding process. Used, for example, for on-the-side Logging.

Attributes

Inherited from:
CommonApi
Generated with