Index

Modules: cbor_serialization, cbor_serialization/format, cbor_serialization/parser, cbor_serialization/reader, cbor_serialization/reader_desc, cbor_serialization/reader_impl, cbor_serialization/types, cbor_serialization/utils, cbor_serialization/writer.

API symbols

`$`:

• types: proc `$`(v: CborSimpleValue): string

`==`:

• types: proc `==`(a, b: CborBytes): bool
• types: proc `==`(a: CborBytes; b: seq[byte]): bool
• types: proc `==`(a, b: CborSimpleValue): bool
• types: proc `==`(lhs, rhs: CborValueRef): bool
• types: proc `==`(a: seq[byte]; b: CborBytes): bool

add:

• types: proc add(a: var CborBytes; b: byte)

beginArray:

• writer: proc beginArray(w: var CborWriter; length = -1)

beginBytes:

• writer: proc beginBytes(w: var CborWriter; length = -1)

beginObject:

• writer: proc beginObject(w: var CborWriter; length = -1)

beginText:

• writer: proc beginText(w: var CborWriter; length = -1)

Cbor:

• format: object Cbor

cborBreakStopCode:

• types: const cborBreakStopCode

CborBytes:

• types: type CborBytes

CborError:

• types: object CborError

cborFalse:

• types: const cborFalse

cborKind:

• parser: proc cborKind(p: CborParser): CborValueKind

CborMajor:

• types: enum CborMajor

cborMinorIndef:

• types: const cborMinorIndef

cborMinorLen0:

• types: const cborMinorLen0

cborMinorLen1:

• types: const cborMinorLen1

cborMinorLen2:

• types: const cborMinorLen2

cborMinorLen4:

• types: const cborMinorLen4

cborMinorLen8:

• types: const cborMinorLen8

cborMinorLens:

• types: const cborMinorLens

cborNull:

• types: const cborNull

CborNumber:

• types: object CborNumber

CborObjectType:

• types: type CborObjectType

CborParser:

• reader_desc: object CborParser

CborReader:

• reader_desc: object CborReader

CborReaderConf:

• types: object CborReaderConf

CborReaderError:

• reader_desc: object CborReaderError

CborSign:

• types: enum CborSign

CborSimpleValue:

• types: type CborSimpleValue

CborTag:

• types: object CborTag

cborTrue:

• types: const cborTrue

cborUndefined:

• types: const cborUndefined

CborValue:

• types: object CborValue

CborValueKind:

• types: enum CborValueKind

CborValueRef:

• types: type CborValueRef

CborVoid:

• types: object CborVoid

CborWriter:

• writer: object CborWriter

configureCborDeserialization:

• reader_impl: template configureCborDeserialization(T: type[enum]; allowNumericRepr: static[bool] = false; stringNormalizer: static[proc (s: string): string] = strictNormalize)

configureCborSerialization:

• writer: template configureCborSerialization(Flavor: type; T: type[enum]; enumRep: static[EnumRepresentation])
• writer: template configureCborSerialization(T: type[enum]; enumRep: static[EnumRepresentation])

contains:

• types: proc contains(x: set[uint8]; y: CborSimpleValue): bool

createCborFlavor:

• format: template createCborFlavor(FlavorName: untyped; mimeTypeValue = "application/cbor"; automaticObjectSerialization = false; automaticPrimitivesSerialization = true; requireAllFields = true; omitOptionalFields = true; allowUnknownFields = true; skipNullFields = false)

decodeHalf:

• utils: proc decodeHalf(half: uint16): float

defaultBuiltinReader:

• format: template defaultBuiltinReader(Flavor: type)

defaultBuiltinSerialization:

• format: template defaultBuiltinSerialization(Flavor: type)

defaultBuiltinWriter:

• format: template defaultBuiltinWriter(Flavor: type)

defaultCborReaderConf:

• types: const defaultCborReaderConf

defaultObjectReader:

• format: template defaultObjectReader(Flavor: type)

defaultObjectSerialization:

• format: template defaultObjectSerialization(Flavor: type)

defaultObjectWriter:

• format: template defaultObjectWriter(Flavor: type)

defaultPrimitiveReader:

• format: template defaultPrimitiveReader(Flavor: type)

defaultPrimitiveSerialization:

• format: template defaultPrimitiveSerialization(Flavor: type)

defaultPrimitiveWriter:

• format: template defaultPrimitiveWriter(Flavor: type)

defaultReader:

• format: template defaultReader(Flavor: type; T: untyped)

defaultReaders:

• format: template defaultReaders(Flavor: type)

defaultSerialization:

• format: template defaultSerialization(Flavor: type)
• format: template defaultSerialization(Flavor: type; T: untyped)

defaultWriter:

• format: template defaultWriter(Flavor: type; T: untyped)

defaultWriters:

• format: template defaultWriters(Flavor: type)

endArray:

• writer: proc endArray(w: var CborWriter; stopCode = true)

endBytes:

• writer: proc endBytes(w: var CborWriter; stopCode = true)

endObject:

• writer: proc endObject(w: var CborWriter; stopCode = true)

endText:

• writer: proc endText(w: var CborWriter; stopCode = true)

EnumAsNumber:

• format: EnumRepresentation.EnumAsNumber

EnumAsString:

• format: EnumRepresentation.EnumAsString

EnumAsStringifiedNumber:

• format: EnumRepresentation.EnumAsStringifiedNumber

EnumRepresentation:

• format: enum EnumRepresentation

expectedFieldsBitmask:

• reader_impl: proc expectedFieldsBitmask(TT: type; fields: static int): auto

flavorAllowsUnknownFields:

• format: template flavorAllowsUnknownFields(T: type DefaultFlavor): bool

flavorEnumRep:

• format: template flavorEnumRep(T: type Cbor; rep: static[EnumRepresentation])
• format: template flavorEnumRep(T: type DefaultFlavor): EnumRepresentation
• format: template flavorEnumRep(T: type DefaultFlavor; rep: static[EnumRepresentation])

flavorOmitsOptionalFields:

• format: template flavorOmitsOptionalFields(T: type DefaultFlavor): bool

flavorRequiresAllFields:

• format: template flavorRequiresAllFields(T: type DefaultFlavor): bool

flavorSkipNullFields:

• format: template flavorSkipNullFields(T: type DefaultFlavor): bool

flavorUsesAutomaticObjectSerialization:

• format: template flavorUsesAutomaticObjectSerialization(T: type DefaultFlavor): bool

formatMsg:

• reader_desc: method formatMsg(err: ref CborReaderError; filename: string): string
• reader_desc: method formatMsg(err: ref IncompleteObjectError; filename: string): string
• reader_desc: method formatMsg(err: ref IntOverflowError; filename: string): string
• reader_desc: method formatMsg(err: ref UnexpectedValueError; filename: string): string

IncompleteObjectError:

• reader_desc: object IncompleteObjectError

init:

• reader_desc: proc init(T: type CborParser; stream: InputStream; conf: CborReaderConf = defaultCborReaderConf): T:type
• reader_desc: proc init(T: type CborReader; stream: InputStream; conf: CborReaderConf = defaultCborReaderConf): T:type
• writer: proc init(W: type CborWriter; stream: OutputStream): W:type

IntOverflowError:

• reader_desc: object IntOverflowError

isFalse:

• types: proc isFalse(v: CborSimpleValue): bool

isFalsy:

• types: proc isFalsy(v: CborSimpleValue): bool

isFieldExpected:

• reader_impl: proc isFieldExpected(T: type): bool

isNull:

• types: proc isNull(v: CborSimpleValue): bool

isNullish:

• types: proc isNullish(v: CborSimpleValue): bool

isTrue:

• types: proc isTrue(v: CborSimpleValue): bool

isUndefined:

• types: proc isUndefined(v: CborSimpleValue): bool

mimeType:

• format: template mimeType(T: type Cbor): string

parseArray:

• parser: template parseArray(r: var CborReader; body: untyped)
• parser: template parseArray(r: var CborReader; idx, body: untyped)

parseBool:

• parser: proc parseBool(r: var CborReader): bool

parseByteString:

• parser: proc parseByteString(r: var CborReader): seq[byte]
• parser: proc parseByteString(r: var CborReader; limit: int): seq[byte]

parseByteStringIt:

• parser: iterator parseByteStringIt(r: var CborReader; limit: int; safeBreak: static[bool] = true): byte
• parser: iterator parseByteStringIt(r: var CborReader; safeBreak: static[bool] = true): byte

parseFloat:

• parser: proc parseFloat(r: var CborReader; T: type SomeFloat): T:type

parseInt:

• parser: proc parseInt(r: var CborReader; T: type SomeInteger): T:type

parseNumber:

• parser: proc parseNumber(r: var CborReader): CborNumber
• parser: proc parseNumber(r: var CborReader; val: var CborNumber)

parseObject:

• parser: template parseObject(r: var CborReader; key: untyped; body: untyped)

parseObjectCustomKey:

• parser: template parseObjectCustomKey(r: var CborReader; keyAction, body: untyped)

parseSimpleValue:

• parser: proc parseSimpleValue(r: var CborReader): CborSimpleValue

parseString:

• parser: proc parseString(r: var CborReader): string
• parser: proc parseString(r: var CborReader; limit: int): string

parseStringIt:

• parser: iterator parseStringIt(r: var CborReader; limit: int; safeBreak: static[bool] = true): char
• parser: iterator parseStringIt(r: var CborReader; safeBreak: static[bool] = true): char

parseTag:

• parser: template parseTag(p: var CborReader; tag: untyped; body: untyped)

parseValue:

• parser: proc parseValue(r: var CborReader): CborValueRef
• parser: proc parseValue(r: var CborReader; val: var CborBytes)
• parser: proc parseValue(r: var CborReader; val: var CborValueRef)

PreferredOutputType:

• writer: template PreferredOutputType(T`gensym0: type Cbor): type

raiseIncompleteObject:

• reader_desc: proc raiseIncompleteObject(p: CborParser; objectType: cstring)

raiseIntOverflow:

• reader_desc: proc raiseIntOverflow(p: CborParser; absIntVal: BiggestUInt; isNegative: bool)

raiseUnexpectedField:

• reader_desc: proc raiseUnexpectedField(p: CborParser; fieldName: string; deserializedType: cstring)

raiseUnexpectedValue:

• reader_desc: proc raiseUnexpectedValue(p: CborParser; msg: string)
• reader_desc: proc raiseUnexpectedValue(p: CborParser; expected, found: string)
• reader_desc: template raiseUnexpectedValue(r: CborReader; msg: string)

read:

• reader_impl: proc read[N](r: var CborReader; value: var array[N, char])
• reader_impl: proc read(r: var CborReader; value: var bool)
• reader_impl: proc read(r: var CborReader; value: var CborBytes)
• reader_impl: proc read(r: var CborReader; value: var CborNumber)
• reader_impl: proc read(r: var CborReader; value: var CborSimpleValue)
• reader_impl: proc read(r: var CborReader; value: var CborTag)
• reader_impl: proc read(r: var CborReader; value: var CborValueRef)
• reader_impl: proc read(r: var CborReader; value: var CborVoid)
• reader_impl: proc read[T](r: var CborReader; value: var ptr T)
• reader_impl: proc read[T](r: var CborReader; value: var ref T)
• reader_impl: proc read(r: var CborReader; value: var seq[byte])
• reader_impl: proc read(r: var CborReader; value: var seq[char])
• reader_impl: proc read[T](r: var CborReader; value: var seq[T])
• reader_impl: proc read(r: var CborReader; value: var string)
• reader_impl: proc read[T: object](r: var CborReader; value: var T)
• reader_impl: proc read[T: tuple](r: var CborReader; value: var T)
• reader_impl: proc read[T: enum](r: var CborReader; value: var T)
• reader_impl: proc read[T: SomeInteger](r: var CborReader; value: var T)
• reader_impl: proc read[T: SomeFloat](r: var CborReader; value: var T)
• reader_impl: proc read[T: array](r: var CborReader; value: var T)

readArray:

• reader_impl: iterator readArray(r: var CborReader; ElemType: typedesc): ElemType:type

Reader:

• reader_desc: template Reader(T`gensym0: type Cbor; F`gensym0: distinct type = DefaultFlavor): type

ReaderType:

• reader_desc: template ReaderType(T`gensym0: type Cbor; F`gensym0: distinct type = DefaultFlavor): type

readObject:

• reader_impl: iterator readObject(r: var CborReader; KeyType: type; ValueType: type): (KeyType:type, ValueType:type)

readObjectFields:

• reader_impl: iterator readObjectFields(r: var CborReader): string
• reader_impl: iterator readObjectFields(r: var CborReader; KeyType: type): KeyType:type

readRecordValue:

• reader_impl: template readRecordValue(r: var CborReader; value: var object)

readValue:

• reader_desc: template readValue[U: Reader(Cbor); W: string](r`gensym5: var U; value`gensym5: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: openArray](r`gensym50: var U; value`gensym50: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: range](r`gensym55: var U; value`gensym55: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: CborNumber](r`gensym61: var U; value`gensym61: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: CborTag](r`gensym66: var U; value`gensym66: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: CborVoid](r`gensym71: var U; value`gensym71: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: CborValueRef](r`gensym76: var U; value`gensym76: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: TT`gensym75](r`gensym81: var U; value`gensym81: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: CborSimpleValue](r`gensym84: var U; value`gensym84: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: CborBytes](r`gensym89: var U; value`gensym89: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: object](r`gensym95: var U; value`gensym95: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: bool](r`gensym10: var U; value`gensym10: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: tuple](r`gensym100: var U; value`gensym100: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: ref](r`gensym15: var U; value`gensym15: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: ptr](r`gensym20: var U; value`gensym20: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: enum](r`gensym25: var U; value`gensym25: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: SomeInteger](r`gensym30: var U; value`gensym30: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: SomeFloat](r`gensym35: var U; value`gensym35: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: seq](r`gensym40: var U; value`gensym40: var W)
• reader_desc: template readValue[U: Reader(Cbor); W: array](r`gensym45: var U; value`gensym45: var W)

shouldWriteObjectField:

• writer: template shouldWriteObjectField[FieldType](field: FieldType): bool

skipSingleValue:

• parser: proc skipSingleValue(r: var CborReader)

streamElement:

• writer: template streamElement(w: var CborWriter; streamVar: untyped; body: untyped)

supports:

• format: template supports(_: type Cbor; T: type): bool

toBytes:

• types: template toBytes(val: CborBytes): untyped

toCbor:

• writer: proc toCbor(v: auto; Flavor = DefaultFlavor): seq[byte]

toInt:

• types: proc toInt(val: CborNumber; T: type SomeSignedInt): Opt[T]
• types: proc toInt(val: CborNumber; T: type SomeUnsignedInt): Opt[T]
• types: proc toInt(sign: CborSign): int

totalExpectedFields:

• reader_impl: proc totalExpectedFields(T: type): int

UnexpectedFieldError:

• reader_desc: object UnexpectedFieldError

UnexpectedValueError:

• reader_desc: object UnexpectedValueError

write:

• writer: proc write(w: var CborWriter; val: bool)
• writer: proc write(w: var CborWriter; val: CborBytes)
• writer: proc write(w: var CborWriter; value: CborNumber)
• writer: proc write(w: var CborWriter; value: CborObjectType)
• writer: proc write(w: var CborWriter; val: CborSimpleValue)
• writer: proc write(w: var CborWriter; val: CborTag)
• writer: proc write(w: var CborWriter; value: CborValue)
• writer: proc write(w: var CborWriter; val: CborVoid)
• writer: proc write(w: var CborWriter; val: cstring)
• writer: proc write(w: var CborWriter; val: openArray[char])
• writer: proc write[T](w: var CborWriter; values: openArray[T])
• writer: proc write[T](w: var CborWriter; val: ref T)
• writer: proc write(w: var CborWriter; val: seq[byte])
• writer: proc write[T: SomeInteger](w: var CborWriter; val: T)
• writer: proc write[T: SomeFloat](w: var CborWriter; val: T)
• writer: proc write[T: object](w: var CborWriter; value: T)
• writer: proc write[T: tuple](w: var CborWriter; value: T)
• writer: proc write[T: range](w: var CborWriter; val: T)
• writer: proc write[T: distinct](w: var CborWriter; val: T)
• writer: template write(w: var CborWriter; value: enum)

writeArray:

• writer: template writeArray[T: void](w: var CborWriter; body: T)

writeByte:

• writer: proc writeByte(w: var CborWriter; x: byte)

writeBytes:

• writer: template writeBytes(w: var CborWriter; length: int; body: untyped)
• writer: template writeBytes(w: var CborWriter; body: untyped)

writeChar:

• writer: proc writeChar(w: var CborWriter; x: char)

writeField:

• writer: proc writeField[V: not void](w: var CborWriter; name: string; value: V)
• writer: template writeField[T: void](w: var CborWriter; name: string; body: T)

writeIterable:

• writer: proc writeIterable(w: var CborWriter; collection: auto)

writeName:

• writer: proc writeName(w: var CborWriter; name: string)

writeObject:

• writer: template writeObject[T: void](w: var CborWriter; body: T)

writeObjectField:

• writer: template writeObjectField[FieldType, ObjectType](w: var CborWriter; obj: ObjectType; fieldName: static string; field: FieldType)

Writer:

• writer: template Writer(T`gensym0: type Cbor; F`gensym0: distinct type = DefaultFlavor): type

writeRecordValue:

• writer: template writeRecordValue(w: var CborWriter; value: object)

WriterType:

• writer: template WriterType(T`gensym0: type Cbor; F`gensym0: distinct type = DefaultFlavor): type

writeText:

• writer: template writeText(w: var CborWriter; length: int; body: untyped)
• writer: template writeText(w: var CborWriter; body: untyped)

writeValue:

• writer: proc writeValue(w: var CborWriter; value: CborNumber)
• writer: template writeValue[U: Writer(Cbor); W: string](w`gensym5: var U; value`gensym5: W)
• writer: template writeValue[U: Writer(Cbor); W: cstring](w`gensym50: var U; value`gensym50: W)
• writer: template writeValue[U: Writer(Cbor); W: openArray](w`gensym55: var U; value`gensym55: W)
• writer: template writeValue[U: Writer(Cbor); W: range](w`gensym60: var U; value`gensym60: W)
• writer: template writeValue[U: Writer(Cbor); W: distinct](w`gensym65: var U; value`gensym65: W)
• writer: template writeValue[U: Writer(Cbor); W: CborNumber](w`gensym71: var U; value`gensym71: W)
• writer: template writeValue[U: Writer(Cbor); W: CborTag](w`gensym76: var U; value`gensym76: W)
• writer: template writeValue[U: Writer(Cbor); W: CborVoid](w`gensym81: var U; value`gensym81: W)
• writer: template writeValue[U: Writer(Cbor); W: CborValueRef](w`gensym86: var U; value`gensym86: W)
• writer: template writeValue[U: Writer(Cbor); W: TT`gensym85](w`gensym91: var U; value`gensym91: W)
• writer: template writeValue[U: Writer(Cbor); W: CborSimpleValue](w`gensym94: var U; value`gensym94: W)
• writer: template writeValue[U: Writer(Cbor); W: bool](w`gensym10: var U; value`gensym10: W)
• writer: template writeValue[U: Writer(Cbor); W: CborBytes](w`gensym99: var U; value`gensym99: W)
• writer: template writeValue[U: Writer(Cbor); W: object](w`gensym105: var U; value`gensym105: W)
• writer: template writeValue[U: Writer(Cbor); W: tuple](w`gensym110: var U; value`gensym110: W)
• writer: template writeValue[U: Writer(Cbor); W: ref](w`gensym15: var U; value`gensym15: W)
• writer: template writeValue[U: Writer(Cbor); W: ptr](w`gensym20: var U; value`gensym20: W)
• writer: template writeValue[U: Writer(Cbor); W: enum](w`gensym25: var U; value`gensym25: W)
• writer: template writeValue[U: Writer(Cbor); W: SomeInteger](w`gensym30: var U; value`gensym30: W)
• writer: template writeValue[U: Writer(Cbor); W: SomeFloat](w`gensym35: var U; value`gensym35: W)
• writer: template writeValue[U: Writer(Cbor); W: seq](w`gensym40: var U; value`gensym40: W)
• writer: template writeValue[U: Writer(Cbor); W: array](w`gensym45: var U; value`gensym45: W)