https://github.com/well-typed/cborg

Binary serialisation in the CBOR format
https://github.com/well-typed/cborg

haskell

Last synced: 3 months ago
JSON representation

Binary serialisation in the CBOR format

• Host: GitHub
• URL: https://github.com/well-typed/cborg
• Owner: well-typed
• Created: 2015-07-06T11:49:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T16:10:42.000Z (6 months ago)
• Last Synced: 2024-10-29T22:00:43.925Z (3 months ago)
• Topics: haskell
• Language: Haskell
• Homepage: https://hackage.haskell.org/package/cborg
• Size: 3.98 MB
• Stars: 190
• Watchers: 24
• Forks: 86
• Open Issues: 58
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Authors: AUTHORS.txt

Awesome Lists containing this project

README

        
# Fast binary serialisation and CBOR implementation for Haskell

![Haskell CI](https://github.com/well-typed/cborg/actions/workflows/haskell-ci.yml/badge.svg)

[![Hackage cborg version](https://img.shields.io/hackage/v/cborg.svg?label=Hackage)](https://hackage.haskell.org/package/cborg)

[![Hackage serialise version](https://img.shields.io/hackage/v/serialise.svg?label=Hackage)](https://hackage.haskell.org/package/serialise)

[![BSD3](https://img.shields.io/badge/License-BSD-blue.svg)](https://en.wikipedia.org/wiki/BSD_License)

[![Haskell](https://img.shields.io/badge/Language-Haskell-yellowgreen.svg)](https://www.haskell.org)

This repo contains two libraries (plus associated tools):

The `serialise` library is for serialising Haskell values and deserialising

them later.

The `cborg` library provides a fast, standards-compliant implementation of the

'Concise Binary Object Representation' (specified in `RFC 7049`) for Haskell.

The `serialise` library uses the CBOR format, via the `cborg` library, which

gives it the following benefits:

 * fast serialisation and deserialisation

 * compact binary format

 * stable format across platforms (32/64bit, big/little endian)

 * support for backwards compatible deserialisation with migrations

 * the ability to inspect binary values with generic tools,

   e.g. for debugging or recovery, including generic conversion into JSON text

 * potential to read the serialised format from other languages

 * incremental or streaming (de)serialisation

 * internal message framing (for use in network application)

 * suitable to use with untrusted input (resistance to asymmetric resource

   consumption attacks)

# Installation

They are just a `cabal install` away on [Hackage][]:

```bash

$ cabal install cborg serialise

```

There are also a few related packages that you may be interested in:

 * `cborg-json` implements the bijection between JSON and CBOR specified in the RFC.

 * `cbor-tool` is a handy command-line utility for working with CBOR data.

[Hackage]:  https://hackage.haskell.org/package/serialise

# Join in

Be sure to read the [contributing guidelines][contribute]. File bugs

in the GitHub [issue tracker][].

Master [git repository][gh]:

* `git clone https://github.com/well-typed/cborg.git`

The tests for the `cborg` package are currently included in the `serialise`

package.

```bash

$ cabal test serialise

```

[contribute]: https://github.com/well-typed/cborg/blob/master/.github/CONTRIBUTING.md

[issue tracker]: http://github.com/well-typed/cborg/issues

[gh]: http://github.com/well-typed/cborg

# Authors

See

[AUTHORS.txt](https://raw.github.com/well-typed/cborg/master/AUTHORS.txt).

# License

BSD3. See

[LICENSE.txt](https://raw.github.com/well-typed/cborg/master/LICENSE.txt)

for the exact terms of copyright and redistribution.