diff options
author | Sam Truzjan <pxqr.sta@gmail.com> | 2013-10-04 14:19:26 +0400 |
---|---|---|
committer | Sam Truzjan <pxqr.sta@gmail.com> | 2013-10-04 14:19:26 +0400 |
commit | 65de3c9477cc6fadaaa7b9374f66ba4e1ca17c4d (patch) | |
tree | 2ac7ff59ac7b8bf04671ebce2dcd3e17b988a514 /src/Data/ByteString | |
parent | 1c2440559d09a75789d36ebbf5030729354aea42 (diff) |
Add documentation for lenient decoding
Diffstat (limited to 'src/Data/ByteString')
-rw-r--r-- | src/Data/ByteString/Base32.hs | 6 | ||||
-rw-r--r-- | src/Data/ByteString/Base32/Hex.hs | 5 |
2 files changed, 8 insertions, 3 deletions
diff --git a/src/Data/ByteString/Base32.hs b/src/Data/ByteString/Base32.hs index 0568c54..5f0eb64 100644 --- a/src/Data/ByteString/Base32.hs +++ b/src/Data/ByteString/Base32.hs | |||
@@ -55,10 +55,12 @@ decW5 !x | |||
55 | decTable :: ByteString | 55 | decTable :: ByteString |
56 | decTable = BS.pack $ L.map decW5 [minBound .. maxBound] | 56 | decTable = BS.pack $ L.map decW5 [minBound .. maxBound] |
57 | 57 | ||
58 | -- | Decode a base32 encoded bytestring. | 58 | -- | Decode a base32 encoded bytestring. This functions is |
59 | -- case-insensitive and do not requires correct padding. | ||
59 | decode :: Base32 -> ByteString | 60 | decode :: Base32 -> ByteString |
60 | decode = pack5 decTable | 61 | decode = pack5 decTable |
61 | 62 | ||
62 | -- | Case-insensitive counterpart of the 'decode'. | 63 | -- | The same as 'decode' but with additional leniency: decodeLenient |
64 | -- will skip non-alphabet characters. | ||
63 | decodeLenient :: Base32 -> ByteString | 65 | decodeLenient :: Base32 -> ByteString |
64 | decodeLenient = pack5Lenient decTable \ No newline at end of file | 66 | decodeLenient = pack5Lenient decTable \ No newline at end of file |
diff --git a/src/Data/ByteString/Base32/Hex.hs b/src/Data/ByteString/Base32/Hex.hs index db5fe1b..3a70055 100644 --- a/src/Data/ByteString/Base32/Hex.hs +++ b/src/Data/ByteString/Base32/Hex.hs | |||
@@ -53,9 +53,12 @@ decW5 !x | |||
53 | decTable :: DecTable | 53 | decTable :: DecTable |
54 | decTable = BS.pack $ L.map decW5 [minBound .. maxBound] | 54 | decTable = BS.pack $ L.map decW5 [minBound .. maxBound] |
55 | 55 | ||
56 | -- | Decode a base32hex encoded bytestring. | 56 | -- | Decode a base32hex encoded bytestring. This functions is |
57 | -- case-insensitive and do not requires correct padding. | ||
57 | decode :: Base32Hex -> ByteString | 58 | decode :: Base32Hex -> ByteString |
58 | decode = pack5 decTable | 59 | decode = pack5 decTable |
59 | 60 | ||
61 | -- | The same as 'decode' but with additional leniency: decodeLenient | ||
62 | -- will skip non-alphabet characters. | ||
60 | decodeLenient :: Base32Hex -> ByteString | 63 | decodeLenient :: Base32Hex -> ByteString |
61 | decodeLenient = pack5Lenient decTable \ No newline at end of file | 64 | decodeLenient = pack5Lenient decTable \ No newline at end of file |