hcobs: An implementation of the Consistent Overhead Byte Stuffing algorithm
Downloads
- hcobs-0.1.0.1.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 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 2018-11-19T00:45:27Z |
| Distributions | |
| Downloads | 1266 total (8 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2018-11-19 [all 1 reports] |
Readme for hcobs-0.1.0.1
[back to package description]hcobs
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]