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

1.7 KiB
Raw Blame History

CBOR

builds.sr.ht status

This library implements the RFC7049: Concise Binary Object Representation (CBOR) in Crystal.

WARNING: This library is still a work in progress.

Features

  • Full support for diagnostic notation
  • Assign a field to a type base on the CBOR tag
  • Support for a wide range of IANA CBOR Tags (see below)

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.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  cbor:
    git: https://git.sr.ht/~arestifo/crystal-cbor

  2. Run shards install

Usage

require "cbor"

TODO: Write usage instructions here

Supported tags

All the tags specified in section 2.4 of RFC 7049 are supported and the values are encoded in the respective Crystal types:

  • Time
  • BigInt
  • BigFloat

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/your-github-user/cbor/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors