Data.Text.Encoding.Base64

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

Documentation

encodeBase64 :: Text -> Text

Encode a Text value in Base64 with padding.

See: RFC-4648 section 4

decodeBase64 :: Text -> Either Text Text

Decode a padded Base64-encoded Text value

See: RFC-4648 section 4

encodeBase64Unpadded :: Text -> Text

Encode a Text value in Base64 without padding.

Note: in some circumstances, the use of padding ("=") in base-encoded data is not required or used. This is not one of them. If you are absolutely sure the length of your text is divisible by 3, this function will be the same as encodeBase64 with padding, however, if not, you may see garbage appended to your text.

Only call unpadded variants when you can make assumptions about the length of your input data.

See: RFC-4648 section 3.2

decodeBase64Unpadded :: Text -> Either Text Text

Decode an unpadded Base64-encoded Text

See: RFC-4648 section 3.2

decodeBase64Lenient :: Text -> Text

Leniently decode a Base64-encoded Text value. This function will not generate parse errors. If input data contains padding chars, then the input will be parsed up until the first pad character.

Note: This is not RFC 4648-compliant.

isBase64 :: Text -> Bool

Tell whether a Text value is Base64-encoded.

isValidBase64 :: Text -> Bool

Tell whether a Text value is a valid Base64 format.

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