core
API
Generated with
core/io.bullet.borer/Cbor

Cbor

io.bullet.borer.Cbor
case object Cbor extends Target

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Target
class Object
trait Matchable
class Any
Show all
Self type
Cbor.type

Members list

Type members

Classlikes

final case class DecodingConfig(readIntegersAlsoAsFloatingPoint: Boolean, readDoubleAlsoAsFloat: Boolean, maxTextStringLength: Int, maxByteStringLength: Int, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends DecodingConfig, Config, 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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Config
trait Config
trait Config
class Object
trait Matchable
class Any
Show all
object DecodingConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class EncodingConfig(bufferSize: Int, allowBufferCaching: Boolean, compressFloatingPointValues: Boolean, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends EncodingConfig, 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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Config
trait Config
class Object
trait Matchable
class Any
Show all
object EncodingConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TransDecodingConfig(readIntegersAlsoAsFloatingPoint: Boolean, readDoubleAlsoAsFloat: Boolean, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends Config, 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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Config
trait Config
class Object
trait Matchable
class Any
Show all
object TransDecodingConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TransEncodingConfig(maxBufferSize: Int, allowBufferCaching: Boolean, compressFloatingPointValues: Boolean, maxArrayLength: Long, maxMapLength: Long, maxNestingLevels: Int) extends TransEncodingConfig, 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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Config
trait Config
class Object
trait Matchable
class Any
Show all
object TransEncodingConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton

Value members

Concrete methods

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

Entry point into the CBOR decoding mini-DSL.

Entry point into the CBOR decoding mini-DSL.

Attributes

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

Entry point into the CBOR encoding mini-DSL.

Entry point into the CBOR encoding mini-DSL.

Attributes

def reader[T](value: T, config: DecodingConfig, receiverWrapper: () => DecodingConfig)(using 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.

Attributes

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.

Attributes

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.

Attributes

Inherited methods

def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with