Documentation

Encoding function.

Encodes as large a part as possible of the indata.

>>> b85_encode_part $ Data.ByteString.Char8.pack "foobar"
("AoDTs","ar")

It supports special handling of both all-zero groups and all-space groups.

>>> b85_encode_part $ Data.ByteString.Char8.pack "    "
("y", "")
>>> b85_encode_part $ Data.ByteString.Char8.pack "\0\0\0\0"
("z", "")

Encoding function for the final block.

>>> b85_encode_final $ Data.ByteString.Char8.pack "ar"
Just "@<)"

Decoding function.

Decode as large a portion of the input as possible.

>>> b85_decode_part $ Data.ByteString.Char8.pack "AoDTs"
Right ("foob","")
>>> b85_decode_part $ Data.ByteString.Char8.pack "AoDTs@<)"
Right ("foob","@<)")
>>> b85_decode_part $ Data.ByteString.Char8.pack "@<)"
Right ("","@<)")

At least 512 bytes of data is allocated for the output, but because of the special handling of all-zero and all-space groups it is possible that the space won't be enough. (To be sure to always fit the output one would have to allocate 5 times the length of the input. It seemed a good trade-off to sometimes have to call the function more than once instead.)

>>> either snd snd $ b85_decode_part $ Data.ByteString.Char8.pack $ Prelude.take 129 $ repeat 'y'
"y"

Decoding function for the final block.

>>> b85_decode_final $ Data.ByteString.Char8.pack "@<)"
Just "ar"
>>> b85_decode_final $ Data.ByteString.Char8.pack ""
Just ""
>>> b85_decode_final $ Data.ByteString.Char8.pack "AoDTs"
Nothing

Convenience function that combines b85_encode_part and b85_encode_final to encode a complete string.

>>> encode  $ Data.ByteString.Char8.pack "foob"
"AoDTs"
>>> encode  $ Data.ByteString.Char8.pack "foobar"
"AoDTs@<)"

Convenience function that combines b85_decode_part and b85_decode_final to decode a complete string.

>>> decode  $ Data.ByteString.Char8.pack "AoDTs"
"foob"
>>> encode  $ Data.ByteString.Char8.pack "AoDTs@<)"
"foobar"