Copyright | (c) 2019-2023 Emily Pillmore |
---|---|
License | BSD-style |
Maintainer | Emily Pillmore <emilypi@cohomolo.gy> |
Stability | stable |
Portability | non-portable |
Safe Haskell | Safe |
Language | Haskell2010 |
This module contains Text
-valued combinators for
implementing the RFC 4648 specification of the Base32
encoding format. This includes strictly padded/unpadded decoding
variants, as well as internal and external validation for canonicity.
Synopsis
- encodeBase32 :: Text -> Text
- encodeBase32Unpadded :: Text -> Text
- decodeBase32 :: Text -> Either Text Text
- decodeBase32With :: (ByteString -> Either err Text) -> ByteString -> Either (Base32Error err) Text
- decodeBase32Unpadded :: Text -> Either Text Text
- decodeBase32UnpaddedWith :: (ByteString -> Either err Text) -> ByteString -> Either (Base32Error err) Text
- decodeBase32Padded :: Text -> Either Text Text
- decodeBase32PaddedWith :: (ByteString -> Either err Text) -> ByteString -> Either (Base32Error err) Text
- isBase32 :: Text -> Bool
- isValidBase32 :: Text -> Bool
Encoding
encodeBase32 :: Text -> Text Source #
Encode a Text
value in Base32 with padding.
See: RFC-4648 section 6
Examples:
>>>
encodeBase32 "Sun"
"KN2W4==="
encodeBase32Unpadded :: Text -> Text Source #
Encode a Text
value in Base32 without padding. Note that for Base32,
padding is optional. If you call this function, you will simply be encoding
as Base32 and stripping padding chars from the output.
See: RFC-4648 section 6
Examples:
>>>
encodeBase32Unpadded "Sun"
"KN2W4"
Decoding
decodeBase32 :: Text -> Either Text Text Source #
Decode an arbitrarily padded Base32-encoded Text
value. If its length is not a multiple
of 4, then padding chars will be added to fill out the input to a multiple of
4 for safe decoding as base32 encodings are optionally padded.
Note: This function makes sure that decoding is total by deferring to
decodeUtf8
. This will always round trip for any valid Base32-encoded
text value, but it may not round trip for bad inputs. The onus is on the
caller to make sure inputs are valid. If unsure, defer to decodeBase32With
and pass in a custom decode function.
See: RFC-4648 section 6
Examples:
>>>
decodeBase32 "KN2W4==="
Right "Sun"
>>>
decodeBase32 "KN2W4"
Right "Sun"
>>>
decodeBase32 "KN2W==="
Left "Base32-encoded bytestring has invalid padding"
:: (ByteString -> Either err Text) | convert a bytestring to text (e.g. |
-> ByteString | Input text to decode |
-> Either (Base32Error err) Text |
Attempt to decode a lazy ByteString
value as Base32, converting from
ByteString
to Text
according to some encoding function. In practice,
This is something like decodeUtf8'
, which may produce an error.
See: RFC-4648 section 6
Examples:
decodeBase32With
decodeUtf8'
::ByteString
->Either
(Base32Error
UnicodeException
)Text
decodeBase32Unpadded :: Text -> Either Text Text Source #
Decode an unpadded Base32 encoded Text
value.
Note: This function makes sure that decoding is total by deferring to
decodeUtf8
. This will always round trip for any valid Base32-encoded
text value, but it may not round trip for bad inputs. The onus is on the
caller to make sure inputs are valid. If unsure, defer to decodeBase32WUnpaddedWith
and pass in a custom decode function.
See: RFC-4648 section 6
Examples:
>>>
decodeBase32Unpadded "KN2W4"
Right "Sun"
>>>
decodeBase32Unpadded "KN2W4==="
Left "Base32-encoded bytestring has invalid padding"
decodeBase32UnpaddedWith Source #
:: (ByteString -> Either err Text) | convert a bytestring to text (e.g. |
-> ByteString | Input text to decode |
-> Either (Base32Error err) Text |
Attempt to decode an unpadded lazy ByteString
value as Base32, converting from
ByteString
to Text
according to some encoding function. In practice,
This is something like decodeUtf8'
, which may produce an error.
See: RFC-4648 section 6
Examples:
decodeBase32UnpaddedWith
decodeUtf8'
::ByteString
->Either
(Base32Error
UnicodeException
)Text
decodeBase32Padded :: Text -> Either Text Text Source #
Decode an padded Base32 encoded Text
value
Note: This function makes sure that decoding is total by deferring to
decodeUtf8
. This will always round trip for any valid Base32-encoded
text value, but it may not round trip for bad inputs. The onus is on the
caller to make sure inputs are valid. If unsure, defer to decodeBase32PaddedWith
and pass in a custom decode function.
See: RFC-4648 section 6
Examples:
>>>
decodeBase32Padded "KN2W4==="
Right "Sun"
>>>
decodeBase32Padded "KN2W4"
Left "Base32-encoded bytestring requires padding"
decodeBase32PaddedWith Source #
:: (ByteString -> Either err Text) | convert a bytestring to text (e.g. |
-> ByteString | Input text to decode |
-> Either (Base32Error err) Text |
Attempt to decode a padded lazy ByteString
value as Base32, converting from
ByteString
to Text
according to some encoding function. In practice,
This is something like decodeUtf8'
, which may produce an error.
See: RFC-4648 section 6
Example:
decodeBase32PaddedWith
decodeUtf8'
::ByteString
->Either
(Base32Error
UnicodeException
)Text
Validation
isBase32 :: Text -> Bool Source #
Tell whether a Text
value is Base32-encoded
Examples:
>>>
isBase32 "KN2W4"
True
>>>
isBase32 "KN2W4==="
True
>>>
isBase32 "KN2W4=="
False
isValidBase32 :: Text -> Bool Source #
Tell whether a Text
value is a valid Base32 format.
This will not tell you whether or not this is a correct Base32 representation,
only that it conforms to the correct shape. To check whether it is a true
Base32 encoded Text
value, use isBase32
.
Examples:
>>>
isValidBase32 "KN2W4"
True
>>>
isValidBase32 "KN2W4="
False
>>>
isValidBase32 "KN2W4%"
False