Baguette
/
crystal-cbor
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document limitations

dev
Alberto Restifo 2020-04-22 22:31:00 +02:00
parent 4958a4c068
commit 2aea52d78f
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -5,6 +5,25 @@
This library implements the [RFC7049: Concise Binary Object Representation (CBOR)][rfc]
in Crystal.
## Limitations
### Maximum Array/String array/Bytes array length
The spec allows for the maximum length of arrays, string arrays and bytes array
to be a `UInt64`.
While this library supports lengths expressed as a `UInt64`, it must not exceed
`Int32::MAX`.
### Diagnostic notation
While this library implements a diagnostic notation to be able to run against
the examples provided in the RFC, the diagnostic notation is not fully
spec-compliant:
- Indefinite length items are not marked with the starting underscore but
represented as their finite counterparts.
## Installation
1. Add the dependency to your `shard.yml`: