Copyright | (c) 2019-2020 Emily Pillmore |
---|---|
License | BSD-style |
Maintainer | Emily Pillmore <emilypi@cohomolo.gy> |
Stability | stable |
Portability | non-portable |
Safe Haskell | Trustworthy |
Language | Haskell2010 |
This module contains ShortText
-valued combinators
implementing the RFC 4648 specification for the Base64
encoding format. This includes lenient decoding variants, and
external + internal validations for canonicity.
Synopsis
- encodeBase64 :: ShortText -> ShortText
- decodeBase64 :: ShortText -> Either Text ShortText
- decodeBase64With :: (ShortByteString -> Either err ShortText) -> ShortByteString -> Either (Base64Error err) ShortText
- decodeBase64Lenient :: ShortText -> ShortText
- isBase64 :: ShortText -> Bool
- isValidBase64 :: ShortText -> Bool
Encoding
encodeBase64 :: ShortText -> ShortText Source #
Encode a ShortText
value in Base64 with padding.
See: RFC-4648 section 4
Examples:
>>>
encodeBase64 "Sun"
"U3Vu"
Decoding
decodeBase64 :: ShortText -> Either Text ShortText Source #
Decode a padded Base64-encoded ShortText
value
Note: This function makes sure that decoding is total by deferring to
decodeLatin1
. This will always round trip for any valid Base64-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 decodeBase64With
and pass in a custom decode function.
See: RFC-4648 section 4
Examples:
>>>
decodeBase64 "U3Vu"
Right "Sun"
>>>
decodeBase64 "U3V"
Left "Base64-encoded bytestring requires padding"
>>>
decodebase64 "U3V="
Left "non-canonical encoding detected at offset: 2"
:: (ShortByteString -> Either err ShortText) | convert a bytestring to text (e.g. |
-> ShortByteString | Input text to decode |
-> Either (Base64Error err) ShortText |
Attempt to decode a ShortByteString
value as Base64, converting from
ByteString
to ShortText
according to some encoding function. In practice,
This is something like decodeUtf8'
, which may produce an error.
See: RFC-4648 section 4
Example:
decodeBase64With
decodeUtf8'
::ShortByteString
->Either
(Base64Error
UnicodeException
)ShortText
decodeBase64Lenient :: ShortText -> ShortText Source #
Leniently decode a Base64-encoded ShortText
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
isBase64 :: ShortText -> Bool Source #
Tell whether a ShortText
value is Base64-encoded.
Examples:
>>>
isBase64 "U3Vu"
True
>>>
isBase64 "U3V"
False
>>>
isBase64 "U3V="
False
isValidBase64 :: ShortText -> Bool Source #
Tell whether a ShortText
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 ShortText
value, use isBase64
.
Examples:
>>>
isValidBase64 "U3Vu"
True
>>>
isValidBase64 "U3V"
True
>>>
isValidBase64 "U3V="
True
>>>
isValidBase64 "%"
False