multipaz/org.multipaz.cbor

Package-level declarations

Types

ArrayBuilder

data class ArrayBuilder<T>(parent: T, array: CborArray)

Array builder.

Bstr

data class Bstr(val value: ByteArray) : DataItem

Byte String (major type 2).

Cbor

object Cbor

CBOR support routines.

CborArray

class CborArray(val items: MutableList<DataItem>, val indefiniteLength: Boolean = false) : DataItem

Array (major type 4).

CborBuilder

class CborBuilder(item: DataItem)

CBOR data item builder.

CborDouble

class CborDouble(val value: Double) : DataItem

Single-precision floating point number (major type 7).

CborFloat

class CborFloat(val value: Float) : DataItem

Single-precision floating point number (major type 7).

CborInt

abstract class CborInt(val majorType: MajorType) : DataItem

Base class for Nint and Uint.

CborMap

class CborMap(val items: MutableMap<DataItem, DataItem>, val indefiniteLength: Boolean = false) : DataItem

Map (major type 5).

DataItem

sealed class DataItem

Abstract base class for CBOR data items.

DiagnosticOption

enum DiagnosticOption : Enum<DiagnosticOption>

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

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.

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)

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

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

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

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

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

buildCborMap

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

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

putCborArray

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

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

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

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

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

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.

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.

toDataItemFullDate

fun LocalDate.toDataItemFullDate(): DataItem

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