https://github.com/mstksg/tagged-binary

Provides tools for serializing data tagged with type information
https://github.com/mstksg/tagged-binary

Last synced: 4 months ago
JSON representation

Provides tools for serializing data tagged with type information

• Host: GitHub
• URL: https://github.com/mstksg/tagged-binary
• Owner: mstksg
• License: mit
• Created: 2014-03-12T06:28:35.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2019-06-28T22:57:56.000Z (almost 6 years ago)
• Last Synced: 2024-12-28T09:33:40.399Z (6 months ago)
• Language: Haskell
• Size: 28.3 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
tagged-binary

=============

[![tagged-binary on

Hackage](https://img.shields.io/hackage/v/tagged-binary.svg?maxAge=2592000)](https://hackage.haskell.org/package/tagged-binary)

[![tagged-binary on Stackage LTS](http://stackage.org/package/tagged-binary/badge/lts)](http://stackage.org/lts/package/tagged-binary)

[![tagged-binary on Stackage Nightly](http://stackage.org/package/tagged-binary/badge/nightly)](http://stackage.org/nightly/package/tagged-binary)

[![Build Status](https://travis-ci.org/mstksg/tagged-binary.svg?branch=master)](https://travis-ci.org/mstksg/tagged-binary)

Very minimal (Haskell) library providing tools for serializing and decoding data into

`ByteString` tagged with information about its type, inspired by Cloud Haskell

and distributed-process.

Intended for use by libraries and frameworks in distributed contexts, such as

distributed computation between native servers and communication between

native servers and ghcjs/various front-ends, for behavior similar to the

polymorphic communication channels of Cloud Haskell and distributed-process;

servers can send tagged data, and clients can choose to selectively accept,

ignore or queue incoming messages depending on their types.

For basic encoding and decoding, only `Data.Binary.Tagged` should be

necessary.  `Data.Binary.Tagged.Internal` is exported in case you need it.

Quick example

-------------

    > let x = encodeTagged (1 :: Int)

    > decodeTagged x :: Maybe Bool

    Nothing

    > decodeTagged x :: Maybe Int

    Just 1

Copyright

---------

Copyright (c) 2015 Justin Le