core/io.bullet.borer/Cbor

Cbor

case object Cbor extends Target
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Target
class Object
trait Matchable
class Any
Cbor.type

Type members

Classlikes

final case class DecodingConfig(readIntegersAlsoAsFloatingPoint: Boolean, readDoubleAlsoAsFloat: Boolean, maxTextStringLength: Int, maxByteStringLength: Int, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends DecodingConfig with Config with Config
Value parameters:
maxArrayLength

the maximum array length to accept

maxByteStringLength

the maximum byte string length to accept

maxMapLength

the maximum map length to accept

maxNestingLevels

the maximum number of nesting levels to accept

maxTextStringLength

the maximum text string length to accept

readDoubleAlsoAsFloat

set to false to disable automatic conversion of Double to Float values

readIntegersAlsoAsFloatingPoint

set to false to disable automatic conversion of integer to floating point values

Companion:
object
object DecodingConfig
Companion:
class
final case class EncodingConfig(bufferSize: Int, allowBufferCaching: Boolean, compressFloatingPointValues: Boolean, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends EncodingConfig with Config
Value parameters:
bufferSize

the buffer size used for configuring the respective Output

compressFloatingPointValues

set to false in order to always write floats as 32-bit values and doubles as 64-bit values, even if they could safely be represented with fewer bits

maxArrayLength

the maximum array length to accept

maxMapLength

the maximum map length to accept

maxNestingLevels

the maximum number of nesting levels to accept

Companion:
object
object EncodingConfig
Companion:
class
final case class TransDecodingConfig(readIntegersAlsoAsFloatingPoint: Boolean, readDoubleAlsoAsFloat: Boolean, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends Config with Config
Value parameters:
maxArrayLength

the maximum array length to accept

maxMapLength

the maximum map length to accept

maxNestingLevels

the maximum number of nesting levels to accept

readDoubleAlsoAsFloat

set to false to disable automatic conversion of Double to Float values

readIntegersAlsoAsFloatingPoint

set to false to disable automatic conversion of integer to floating point values

Companion:
object
object TransDecodingConfig
Companion:
class
final case class TransEncodingConfig(maxBufferSize: Int, allowBufferCaching: Boolean, compressFloatingPointValues: Boolean, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends TransEncodingConfig with Config
Value parameters:
compressFloatingPointValues

set to false in order to always write floats as 32-bit values and doubles as 64-bit values, even if they could safely be represented with fewer bits

maxArrayLength

the maximum array length to accept

maxBufferSize

the max number of transcoding elements (not bytes!) that can be buffered

maxMapLength

the maximum map length to accept

maxNestingLevels

the maximum number of nesting levels to accept

Companion:
object
object TransEncodingConfig
Companion:
class

Inherited types

type MirroredElemLabels = EmptyTuple
Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple
Inherited from:
Singleton
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror
type MirroredMonoType = Singleton
Inherited from:
Singleton
type MirroredType = Singleton
Inherited from:
Singleton

Value members

Concrete methods

def decode[T](value: T)(implicit p: Provider[T]): Api[DecodingConfig]

Entry point into the CBOR decoding mini-DSL.

Entry point into the CBOR decoding mini-DSL.

def encode[T : Encoder](value: T): Api[EncodingConfig]

Entry point into the CBOR encoding mini-DSL.

Entry point into the CBOR encoding mini-DSL.

def reader[T](value: T, config: DecodingConfig, receiverWrapper: () => DecodingConfig)(implicit p: Provider[T]): Reader

Constructs a new Reader that reads CBOR from the given Input.

Constructs a new Reader that reads CBOR from the given Input.

def transEncode[T : Encoder](value: T): EncodingApi[TransEncodingConfig, TransDecodingConfig]

Entry point into the CBOR transcoding mini-DSL.

Entry point into the CBOR transcoding mini-DSL.

def writer(output: Output, config: EncodingConfig, receiverWrapper: () => EncodingConfig): Writer

Constructs a new Writer that writes CBOR to the given Output.

Constructs a new Writer that writes CBOR to the given Output.

Inherited methods

def fromProduct(p: Product): MirroredMonoType
Inherited from:
Singleton
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product