data class CdnGeneratorOptions(val prettyPrint: Boolean = false, val indentSize: Int = 2, val byteStringFormat: ByteStringFormat = ByteStringFormat.HEX, val useEmbeddedCborShorthand: Boolean = true, val useEmbeddedCborOpportunistically: Boolean = true, val useEmbeddedCertsOpportunistically: Boolean = true, val useApplicationExtensions: Boolean = true, val sortMapKeys: Boolean = false, val annotateCoseOpportunistically: Boolean = true, val extensionRegistry: CdnExtensionRegistry = CdnExtensionRegistry.Default)

Options for CDN text generation (serializing DataItem to CDN string).

CdnParserOptions

data class CdnParserOptions(val extensionRegistry: CdnExtensionRegistry = CdnExtensionRegistry.Default, val maxDepth: Int = 100)

Options for CDN text parsing (parsing CDN text to DataItem).

CertExtension

object CertExtension : CdnExtension

Extension for X.509 certificates: cert'''-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'''.

DataItem

sealed class DataItem

Abstract base class for CBOR data items.

DateTimeExtension

object DateTimeExtension : CdnExtension

Extension for RFC 3339 Date/Time: dt'2026-07-27T16:00:00Z'.

DiagnosticOption

enum DiagnosticOption : Enum<DiagnosticOption>

Enumeration of options that can be passed to Cbor.toDiagnostics.

FloatExtension

object FloatExtension : CdnExtension

Extension for explicit floating point precision bit-widths: float'16(0x7c00)'.

HexExtension

object HexExtension : CdnExtension

Extension for Hexadecimal byte strings: h'01020304' or h"01020304".

IndefLengthBstr

data class IndefLengthBstr(val chunks: List<ByteArray>) : DataItem

Byte String (major type 2), indefinite length.

IndefLengthTstr

data class IndefLengthTstr(val chunks: List<String>) : DataItem

Unicode String (major type 3), indefinite length.

IpExtension

object IpExtension : CdnExtension

Extension for IP addresses: ip'192.168.1.1' or ip'2001:db8::1'.

MajorType

enum MajorType : Enum<MajorType>

CBOR major types.

MapBuilder

class MapBuilder<T>(parent: T, map: CborMap)

Map builder.

Nint

class Nint(val value: ULong) : CborInt

Negative Integer (major type 1).

RawCbor

class RawCbor(val encodedCbor: ByteArray) : DataItem

Data item for raw CBOR.

Simple

class Simple(val value: UInt) : DataItem

Simple (major type 7)

StringConcatByteExtension

object StringConcatByteExtension : CdnExtension

Extension for Byte String Concatenation: b1'...'.

StringConcatTextExtension

object StringConcatTextExtension : CdnExtension

Extension for Text String Concatenation: t1'...'.

Tagged

class Tagged(val tagNumber: Long, val taggedItem: DataItem) : DataItem

Tag (major type 6).

Tstr

class Tstr(val value: String) : DataItem

Unicode String (major type 3).

Uint

class Uint(val value: ULong) : CborInt

Unsigned Integer (major type 0).

Functions

addCborArray

inline fun <T> ArrayBuilder<T>.addCborArray(builderAction: ArrayBuilder<ArrayBuilder<T>>.() -> Unit)

Adds the DataItem for a CBOR array produced by the given builder action to a CBOR array.

addCborMap

inline fun <T> ArrayBuilder<T>.addCborMap(builderAction: MapBuilder<ArrayBuilder<T>>.() -> Unit)

Adds the DataItem for a CBOR map produced by the given builder action to a CBOR array.

buildCborArray

inline fun buildCborArray(builderAction: ArrayBuilder<CborBuilder>.() -> Unit): DataItem

Builds a DataItem for a CBOR array with the given builder action.

buildCborMap

inline fun buildCborMap(builderAction: MapBuilder<CborBuilder>.() -> Unit): DataItem

Builds a DataItem for a CBOR map with the given builder action.

putCborArray

inline fun <T> MapBuilder<T>.putCborArray(key: Long, builderAction: ArrayBuilder<MapBuilder<T>>.() -> Unit)

inline fun <T> MapBuilder<T>.putCborArray(key: String, builderAction: ArrayBuilder<MapBuilder<T>>.() -> Unit)

inline fun <T> MapBuilder<T>.putCborArray(key: DataItem, builderAction: ArrayBuilder<MapBuilder<T>>.() -> Unit)

Adds the DataItem for a CBOR array produced by the given builder action to a CBOR map.

putCborMap

inline fun <T> MapBuilder<T>.putCborMap(key: Long, builderAction: MapBuilder<MapBuilder<T>>.() -> Unit)

inline fun <T> MapBuilder<T>.putCborMap(key: String, builderAction: MapBuilder<MapBuilder<T>>.() -> Unit)

inline fun <T> MapBuilder<T>.putCborMap(key: DataItem, builderAction: MapBuilder<MapBuilder<T>>.() -> Unit)

Adds the DataItem for a CBOR map produced by the given builder action to a CBOR map.

toCdn

fun DataItem.toCdn(options: CdnGeneratorOptions = CdnGeneratorOptions.Default): String

Extension function to convert a DataItem to a CDN string representation.

toDataItem

fun Boolean.toDataItem(): Simple

Extension to get a Simple data item for the value.

fun Byte.toDataItem(): CborInt

fun Int.toDataItem(): CborInt

fun Long.toDataItem(): CborInt

fun Short.toDataItem(): CborInt

Extension to get a CborInt data item for the value.

fun ByteArray.toDataItem(): Bstr

Extension to get a Bstr data item for the value.

fun Double.toDataItem(): CborDouble

Extension to get a CborDouble data item for the value.

fun Float.toDataItem(): CborFloat

Extension to get a CborFloat data item for the value.

fun String.toDataItem(): Tstr

Extension to get a Tstr data item for the value.

toDataItemDateTimeString

fun Long.toDataItemDateTimeString(): DataItem

fun Instant.toDataItemDateTimeString(): DataItem

Extension to get a date-time string data item for a point in time.

fun String.toDataItemDateTimeString(): DataItem

Extension to get a date-time string data item for a RFC 3339-formatted string representing a point in time.

toDataItemFromCdn

fun String.toDataItemFromCdn(options: CdnParserOptions = CdnParserOptions.Default): DataItem

Extension function to parse a CDN string representation into a DataItem.

toDataItemFullDate

fun LocalDate.toDataItemFullDate(): DataItem

Extension to get a full-date data item as specified in RFC 8943.