Data.ByteString.Base32.Hex

This module contains the combinators implementing the RFC 4648 specification for the Base32-Hex encoding including unpadded and lenient variants

Documentation

encodeBase32 :: ByteString -> Text

Encode a ByteString value as a Base32hex Text value with padding.

See: RFC-4648 section 7

encodeBase32' :: ByteString -> ByteString

Encode a ByteString as a Base32hex ByteString value with padding.

See: RFC-4648 section 7

decodeBase32 :: ByteString -> Either Text ByteString

Decode a padded Base32hex encoded ByteString value.

See: RFC-4648 section 7

encodeBase32Unpadded :: ByteString -> Text

Encode a ByteString as a Base32hex Text value without padding.

See: RFC-4648 section 7, RFC-4648 section 3.2

encodeBase32Unpadded' :: ByteString -> ByteString

Encode a ByteString as a Base32hex ByteString value without padding.

See: RFC-4648 section 7, RFC-4648 section 3.2

decodeBase32Unpadded :: ByteString -> Either Text ByteString

Decode an arbitrarily padded Base32hex encoded ByteString value.

See: RFC-4648 section 7, RFC-4648 section 3.2

isBase32Hex :: ByteString -> Bool

Tell whether a ByteString is Base32hex-encoded.

isValidBase32Hex :: ByteString -> Bool

Tell whether a ByteString 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 ByteString value, use isBase32Hex.