ddb2615031 | ||
---|---|---|
spec | ||
src | ||
.build.yml | ||
.editorconfig | ||
.gitignore | ||
LICENSE | ||
README.md | ||
shard.yml |
README.md
CBOR
This library implements the RFC7049: Concise Binary Object Representation (CBOR) 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
-
Add the dependency to your
shard.yml
:dependencies: cbor: git: https://git.sr.ht/~arestifo/crystal-cbor
-
Run
shards install
Usage
require "cbor"
TODO: Write usage instructions here
Development
TODO: Write development instructions here
Contributing
- Fork it (https://github.com/your-github-user/cbor/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Contributors
- Alberto Restifo - creator and maintainer