Data.Text.Encoding.Base32.Hex

This module contains Text-valued combinators for implementing the RFC 4648 specification of the Base32hex encoding format. This includes strictly padded and unpadded decoding variants, as well as internal and external validation for canonicity.

Documentation

encodeBase32 :: Text -> Text

Encode a Text value in Base32hex with padding.

See: RFC-4648 section 6

Examples:

>>> encodeBase32 "Sun"
"ADQMS==="

decodeBase32 :: Text -> Either Text Text

Decode a padded Base32hex-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 base32hex 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 "ADQMS==="
Right "Sun"

>>> decodeBase32 "ADQMS"
Right "Sun"

>>> decodeBase32 "ADQMS==="
Left "Base32-encoded bytestring has invalid padding"

decodeBase32With

Arguments

:: (ByteString -> Either err Text)

convert a bytestring to text (e.g. decodeUtf8')

-> ByteString

Input text to decode

-> Either (Base32Error err) Text

Attempt to decode a ByteString value as Base32hex, 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'
  :: Text -> Either (Base32Error UnicodeException) Text

encodeBase32Unpadded :: Text -> Text

Encode a Text value in Base32hex without padding. Note that for Base32hex, padding is optional. If you call this function, you will simply be encoding as Base32hex and stripping padding chars from the output.

See: RFC-4648 section 7

Examples:

>>> encodeBase32Unpadded "Sun"
"ADQMS"

decodeBase32Unpadded :: Text -> Either Text Text

Decode an unpadded Base32hex 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 "ADQMS"
Right "Sun"

>>> decodeBase32Unpadded "ADQMS==="
Left "Base32-encoded bytestring has invalid padding"

decodeBase32UnpaddedWith

Arguments

:: (ByteString -> Either err Text)

convert a bytestring to text (e.g. decodeUtf8')

-> ByteString

Input text to decode

-> Either (Base32Error err) Text

Attempt to decode an unpadded ByteString value as Base32hex, 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:

decodeBase32UnpaddedWith decodeUtf8'
  :: ByteString -> Either (Base32Error UnicodeException) Text

decodeBase32Padded :: Text -> Either Text Text

Decode an padded Base32hex 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 "ADQMS==="
Right "Sun"

>>> decodeBase32Padded "ADQMS"
Left "Base32-encoded bytestring requires padding"

decodeBase32PaddedWith

Arguments

:: (ByteString -> Either err Text)

convert a bytestring to text (e.g. decodeUtf8')

-> ByteString

Input text to decode

-> Either (Base32Error err) Text

Attempt to decode a padded ByteString value as Base32hex, 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

isBase32Hex :: Text -> Bool

Tell whether a Text value is Base32hex-encoded.

Examples:

>>> isBase32Hex "ADQMS"
True

>>> isBase32Hex "ADQMS==="
True

>>> isBase32Hex "ADQMS=="
False

isValidBase32Hex :: Text -> Bool

Tell whether a Text value is a valid Base32hex format.

This will not tell you whether or not this is a correct Base32hex representation, only that it conforms to the correct shape. To check whether it is a true Base32 encoded Text value, use isBase32Hex.

Examples:

>>> isValidBase32Hex "ADQMS"
True

>>> isValidBase32Hex "ADQMS="
False

>>> isValidBase32Hex "ADQMS%"
False