Small refactor (#7)

Author: nitely

README.md

@@ -34,18 +34,16 @@ requires "cbor_serialization"
 Create a type and use it to encode and decode CBOR:
 
 ```nim
-import cbor_serialization, stew/[byteutils]
+import cbor_serialization
 
 type Request = object
   cborrpc: string
   `method`: string
 
-# {"cborrpc": "2.0", "method": "name"}
-let cbor = hexToSeqByte "0xA26763626F7272706363322E30666D6574686F64646E616D65"
-let decoded = Cbor.decode(cbor, Request)
+let encoded = Cbor.encode(Request(cborrpc: "2.0", `method`: "name"))
+let decoded = Cbor.decode(encoded, Request)
 
 echo decoded.cborrpc
-echo Cbor.encode(decoded).to0xHex()
 ```
 
 ## Documentation

cbor_serialization.nimble

@@ -16,7 +16,7 @@ description = "Flexible CBOR serialization not relying on run-time type informat
 license = "Apache License 2.0"
 skipDirs = @["tests", "fuzzer"]
 
-requires "nim >= 2.0.0", "serialization", "stew >= 0.4.1", "results"
+requires "nim >= 2.0.0", "serialization >= 0.4.9", "stew >= 0.4.1", "results"
 
 #feature "bigints":
 #  require "bigints"

cbor_serialization/pkg/bigints.nim

@@ -44,21 +44,21 @@ proc writeValue*(writer: var CborWriter, value: BigInt) {.raises: [IOError].} =
   if value >= 0.initBigInt:
     let sint = toInt[uint64](value)
     if sint.isSome:
-      writer.writeValue(CborNumber(sign: CborSign.None, integer: sint.get()))
+      writer.write(CborNumber(sign: CborSign.None, integer: sint.get()))
     else:
       var bintTag = CborTag[seq[byte]](tag: unsignedTag)
       toBytes(value, bintTag.val)
-      writer.writeValue(bintTag)
+      writer.write(bintTag)
   else:
     var bint = value.abs()
     dec(bint, 1)
     let sint = toInt[uint64](bint)
     if sint.isSome:
-      writer.writeValue(CborNumber(sign: CborSign.Neg, integer: sint.get()))
+      writer.write(CborNumber(sign: CborSign.Neg, integer: sint.get()))
     else:
       var bintTag = CborTag[seq[byte]](tag: negativeTag)
       toBytes(bint, bintTag.val)
-      writer.writeValue(bintTag)
+      writer.write(bintTag)
 
 proc readValue*(
     reader: var CborReader, value: var BigInt

cbor_serialization/reader_impl.nim

@@ -88,9 +88,11 @@ func expectedFieldsBitmask*(TT: type, fields: static int): auto {.compileTime.}
 proc readRecordValue*[T](
     r: var CborReader, value: var T
 ) {.raises: [SerializationError, IOError].} =
+  mixin flavorAllowsUnknownFields, flavorRequiresAllFields
   type
-    ReaderType {.used.} = type r
-    T = type value
+    ReaderType = typeof(r)
+    Flavor = ReaderType.Flavor
+    T = typeof(value)
 
   const
     fieldsTable = T.fieldReadersTable(ReaderType)
@@ -115,18 +117,18 @@ proc readRecordValue*[T](
         let reader = fieldsTable[fieldIdx].reader
         reader(value, r)
         encounteredFields.setBitInArray(fieldIdx)
-      elif flavorAllowsUnknownFields(r.Flavor):
+      elif flavorAllowsUnknownFields(Flavor):
         r.skipSingleValue()
       else:
         r.parser.raiseUnexpectedField(key, cstring typeName)
 
-    if flavorRequiresAllFields(r.Flavor) and
+    if flavorRequiresAllFields(Flavor) and
         not expectedFields.isBitwiseSubsetOf(encounteredFields):
       r.parser.raiseIncompleteObject(typeName)
   else:
     r.parseObject(key):
       # avoid bloat by putting this if inside parseObject
-      if flavorAllowsUnknownFields(r.Flavor):
+      if flavorAllowsUnknownFields(Flavor):
         r.skipSingleValue()
       else:
         r.parser.raiseUnexpectedField(key, cstring typeName)

cbor_serialization/writer.nim

@@ -96,6 +96,9 @@ proc writeHead(
   else:
     discard
 
+proc writeHead(w: var CborWriter, majorType: CborMajor) {.raises: [IOError].} =
+  w.stream.write initialByte(majorType, cborMinorIndef)
+
 func inObject(w: CborWriter): bool =
   w.stack.len > 0 and w.stack[^1] == CborMajor.Map
 
@@ -137,7 +140,7 @@ proc beginObject*(w: var CborWriter, length = -1) {.raises: [IOError].} =
   if length >= 0:
     w.writeHead(CborMajor.Map, length.uint64)
   else:
-    w.stream.write initialByte(CborMajor.Map, cborMinorIndef)
+    w.writeHead(CborMajor.Map)
 
   w.wantName = true
   w.stack.add CborMajor.Map
@@ -161,7 +164,7 @@ proc beginArray*(w: var CborWriter, length = -1) {.raises: [IOError].} =
   if length >= 0:
     w.writeHead(CborMajor.Array, length.uint64)
   else:
-    w.stream.write initialByte(CborMajor.Array, cborMinorIndef)
+    w.writeHead(CborMajor.Array)
 
   w.stack.add CborMajor.Array
 
@@ -191,7 +194,7 @@ proc beginStringLike(
     w.writeHead(kind, length.uint64)
     w.wantBytes = true
   else:
-    w.stream.write initialByte(kind, cborMinorIndef)
+    w.writeHead(kind)
     w.wantBytesElm = true
 
   w.stack.add kind
@@ -305,11 +308,11 @@ proc write*(w: var CborWriter, val: SomeFloat) {.raises: [IOError].} =
   w.streamElement(s):
     case val.classify
     of fcNan:
-      s.write [initialByte(CborMajor.SimpleOrFloat, cborMinorLen2), 0x7E'u8, 0x00'u8]
+      w.writeHead(CborMajor.SimpleOrFloat, 0x7E00'u16)
     of fcInf:
-      s.write [initialByte(CborMajor.SimpleOrFloat, cborMinorLen2), 0x7C'u8, 0x00'u8]
+      w.writeHead(CborMajor.SimpleOrFloat, 0x7C00'u16)
     of fcNegInf:
-      s.write [initialByte(CborMajor.SimpleOrFloat, cborMinorLen2), 0xFC'u8, 0x00'u8]
+      w.writeHead(CborMajor.SimpleOrFloat, 0xFC00'u16)
     else:
       # VM requires this cast dance because float32 has 64-bit precision
       #if val == float32(val):
@@ -437,13 +440,16 @@ proc writeRecordValue*(w: var CborWriter, value: object | tuple) {.raises: [IOEr
       discard fieldName
   w.endObject(stopCode = false)
 
-proc writeValue*(w: var CborWriter, value: CborNumber) {.raises: [IOError].} =
+proc write*(w: var CborWriter, value: CborNumber) {.raises: [IOError].} =
   w.streamElement(_):
     if value.sign == CborSign.Neg:
       w.writeHead(CborMajor.Negative, value.integer)
     else:
       w.writeHead(CborMajor.Unsigned, value.integer)
 
+proc writeValue*(w: var CborWriter, value: CborNumber) {.raises: [IOError].} =
+  w.write(value)
+
 proc writeValue*(w: var CborWriter, value: CborObjectType) {.raises: [IOError].} =
   var fieldCount = 0
   for _, v in value: