base64-0.3.1.1: RFC 4648-compliant padded and unpadded base64 and base64url encodings

Copyright(c) 2019 Emily Pillmore
LicenseBSD-style
MaintainerEmily Pillmore <emilypi@cohomolo.gy>
StabilityExperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Data.ByteString.Base64

Description

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

Synopsis

Documentation

encodeBase64 :: ByteString -> Text Source #

Encode a ByteString value as Base64 Text with padding.

See: RFC-4648 section 4

encodeBase64' :: ByteString -> ByteString Source #

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

See: RFC-4648 section 4

decodeBase64 :: ByteString -> Either Text ByteString Source #

Decode a padded Base64-encoded ByteString value.

See: RFC-4648 section 4

encodeBase64Unpadded :: ByteString -> Text Source #

Encode a ByteString value as Base64 Text 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 bytestring is divisible by 3, this function will be the same as encodeBase64 with padding, however, if not, you may see garbage appended to your bytestring.

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

See: RFC-4648 section 3.2

encodeBase64Unpadded' :: ByteString -> ByteString Source #

Encode a ByteString value as 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 bytestring is divisible by 3, this function will be the same as encodeBase64 with padding, however, if not, you may see garbage appended to your bytestring.

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

See: RFC-4648 section 3.2

decodeBase64Unpadded :: ByteString -> Either Text ByteString Source #

Decode an unpadded Base64-encoded ByteString.

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

See: RFC-4648 section 3.2

decodeBase64Lenient :: ByteString -> ByteString Source #

Leniently decode an unpadded Base64-encoded ByteString 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 :: ByteString -> Bool Source #

Tell whether a ByteString value is base64 encoded.

isValidBase64 :: ByteString -> Bool Source #

Tell whether a ByteString value is a valid Base64 format.

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