hcobs: An implementation of the Consistent Overhead Byte Stuffing algorithm

[ bsd3, codec, library ] [ Propose Tags ]

An implementation of the Consistent Overhead Byte Stuffing algorithm.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1
Dependencies base (>=4.7 && <5), bytestring, containers, ghc-prim, reflection [details]
License BSD-3-Clause
Copyright 2017 Dario Bertini
Author Dario Bertini
Maintainer berdario@gmail.com
Category Codec
Home page https://github.com/berdario/hcobs#readme
Source repo head: git clone https://github.com/berdario/hcobs
Uploaded by berdario at Mon Nov 19 00:45:27 UTC 2018
Distributions NixOS:0.1.0.1
Downloads 268 total (24 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2018-11-19 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hcobs-0.1.0.1

[back to package description]

hcobs

Build Status

Haskell implementation of the Consistent Overhead Byte Stuffing algorithm.

It provides a Stuffed newtype wrapper for Lazy Bytestrings, which is parametrized on the Byte (Word8, represented as a type-level Nat) to be encoded away.

The implementation tries to be as efficient as possible, type safe and easy to use. If you have a "sink" like

sink :: Stuffed 0 -> IO ()
sink = undefined

You'd then simply be able to encode a Bytestring with sink $ stuff bytes.

You can try this out in ghci with:

> :set -XOverloadedStrings
> :set -XDataKinds
> import Data.Stuffed
> let stuffedBytes = stuff "a\0b\0c" :: Stuffed 0
> unpack $ unwrap stuffedBytes -- directly access the underlying bytestring
[2,97,2,98,2,99]
> unpack $ unstuff stuffedBytes
[97,0,98,0,99]