Encode a ShortByteString value as Base64 ShortText with padding.
See: RFC-4648 section 4
Examples:
encodeBase64 "Sun""U3Vu"
Modulebase64-1.0Haskell2010
Data.ByteString.Short.Base64
This module contains ShortByteString-valued combinators for implementing the RFC 4648 specification of the Base64 encoding format. This includes lenient decoding variants, as well as internal and external validation for canonicity.
Contents
Synopsis
- value encodeBase64
- value encodeBase64'
- value decodeBase64
- value decodeBase64Untyped
- value decodeBase64Lenient
- value isBase64
- value isValidBase64
- Packagebase64-1.0
- Exports7
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceBase64.hs
Encoding
Encode a ShortByteString value as a Base64 ShortByteString value with padding.
See: RFC-4648 section 4
Examples:
encodeBase64' "Sun""U3Vu"
Decoding
Decode a padded Base64-encoded ShortByteString value.
See: RFC-4648 section 4
Examples:
decodeBase64 $ assertBase64 @'StdPadded "U3Vu""Sun"
Decode a padded Base64-encoded ShortByteString value.
See: RFC-4648 section 4
Examples:
decodeBase64Untyped "U3Vu"Right "Sun"
decodeBase64Untyped "U3V"Left "Base64-encoded bytestring requires padding"
decodeBase64Untyped "U3V="Left "non-canonical encoding detected at offset: 2"
Leniently decode an unpadded Base64-encoded ShortByteString 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.
Examples:
decodeBase64Lenient "U3Vu""Sun"
decodeBase64Lenient "U3V""Su"
decodeBase64Lenient "U3V=""Su"
Validation
Tell whether a ShortByteString value is base64 encoded.
This function will also detect non-canonical encodings such as ZE==, which are
externally valid Base64-encoded values, but are internally inconsistent "impossible"
values.
Examples:
isBase64 "U3Vu"True
isBase64 "U3V"False
isBase64 "U3V="False
Tell whether a ShortByteString 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 ShortByteString value, use isBase64.
Examples:
isValidBase64 "U3Vu"True
isValidBase64 "U3V"True
isValidBase64 "U3V="True
isValidBase64 "%"False