z85: Implementation of the z85 binary codec

[ bsd3, data, library ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/athanclark/z85#readme


[Skip to Readme]
Versions [faq] 0.0.0, 0.0.1, 0.0.2
Change log ChangeLog.md
Dependencies attoparsec, attoparsec-binary (>=0.2), base (>=4.8 && <4.12), bytestring, pipes (>=4.0 && <4.4), pipes-bytestring (>=2.1.6), pipes-text (>=0.0.2.5), QuickCheck, text, vector-sized [details]
License BSD-3-Clause
Copyright Copyright (c) 2018 Athan Clark
Author Athan Clark
Maintainer athan.clark@localcooking.com
Category Data
Home page https://github.com/athanclark/z85#readme
Bug tracker https://github.com/athanclark/z85/issues
Source repo head: git clone https://github.com/athanclark/z85
Uploaded by athanclark at Sun Dec 30 18:03:20 UTC 2018
Distributions NixOS:0.0.2
Downloads 366 total (30 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2018-12-30 [all 3 reports]

Modules

  • Data
    • Attoparsec
      • ByteString
        • Data.Attoparsec.ByteString.Z85
      • Text
        • Data.Attoparsec.Text.Z85
    • ByteString
      • Data.ByteString.Z85
        • Data.ByteString.Z85.Internal
  • Pipes
    • Pipes.Z85

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for z85-0.0.2

[back to package description]

z85

z85 is a binary string codec, like hexadecimal or base64, but has a higher density of compression than the former, due to its use of a higher base value of 85 than base 64. ByteStrings just need to be a length of a multiple of 4 (a Word32String might be a better name).

There are multiple layers of exposed implementation in this package

  • Word32 <-> Vector 4 Z85Char for low level work
  • Attoparsec Parser ByteString <-> Parser Text for slightly higher level parsing of strict data
  • Pipes Pipe ByteString Text <-> Pipe Text ByteString for encoding / decoding streams of strict data
  • Casual Lazy.ByteString ~ Lazy.Text functions for encoding / decoding lazy data.