Data.ByteString.Base32

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

Documentation

encodeBase32 :: ByteString -> Text

Encode a ByteString value as Base32 Text with padding.

See: RFC-4648 section 6

encodeBase32' :: ByteString -> ByteString

Encode a ByteString value as a Base32 ByteString value with padding.

See: RFC-4648 section 6

decodeBase32 :: ByteString -> Either Text ByteString

Decode a padded Base32-encoded ByteString value.

See: RFC-4648 section 6

encodeBase32Unpadded :: ByteString -> Text

Encode a ByteString value as a Base32 Text value without padding.

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

encodeBase32Unpadded' :: ByteString -> ByteString

Encode a ByteString value as a Base32 ByteString value with padding.

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

decodeBase32Unpadded :: ByteString -> Either Text ByteString

Decode an arbitarily padded Base32-encoded ByteString value.

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

isBase32 :: ByteString -> Bool

Tell whether a ByteString value is base32 encoded.

isValidBase32 :: ByteString -> Bool

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