-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | RFC 4648-compliant padded and unpadded base64 and base64url encodings
--   
--   RFC 4648-compliant padded and unpadded base64 and base64url encoding
--   and decoding.
@package base64
@version 0.3.1.1


-- | This module contains the combinators implementing the RFC 4648
--   specification for the Base64 encoding including unpadded and lenient
--   variants
module Data.ByteString.Base64

-- | Encode a <a>ByteString</a> value as Base64 <a>Text</a> with padding.
--   
--   See: <a>RFC-4648 section 4</a>
encodeBase64 :: ByteString -> Text

-- | Encode a <a>ByteString</a> value as a Base64 <a>ByteString</a> value
--   with padding.
--   
--   See: <a>RFC-4648 section 4</a>
encodeBase64' :: ByteString -> ByteString

-- | Decode a padded Base64-encoded <a>ByteString</a> value.
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64 :: ByteString -> Either Text ByteString

-- | Encode a <a>ByteString</a> value as Base64 <a>Text</a> without
--   padding.
--   
--   <b>Note:</b> 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 <a>encodeBase64</a> 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: <a>RFC-4648 section 3.2</a>
encodeBase64Unpadded :: ByteString -> Text

-- | Encode a <a>ByteString</a> value as Base64 without padding.
--   
--   <b>Note:</b> 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 <a>encodeBase64</a> 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: <a>RFC-4648 section 3.2</a>
encodeBase64Unpadded' :: ByteString -> ByteString

-- | Decode an unpadded Base64-encoded <a>ByteString</a>.
--   
--   <b>Note:</b> Only call unpadded variants when you can make assumptions
--   about the length of your input data.
--   
--   See: <a>RFC-4648 section 3.2</a>
decodeBase64Unpadded :: ByteString -> Either Text ByteString

-- | Leniently decode an unpadded Base64-encoded <a>ByteString</a> 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.
--   
--   <b>Note:</b> This is not RFC 4648-compliant.
decodeBase64Lenient :: ByteString -> ByteString

-- | Tell whether a <a>ByteString</a> value is base64 encoded.
isBase64 :: ByteString -> Bool

-- | Tell whether a <a>ByteString</a> 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 <a>ByteString</a> value, use
--   <a>isBase64</a>.
isValidBase64 :: ByteString -> Bool


-- | This module contains the combinators implementing the RFC 4648
--   specification for the Base64-URL encoding including unpadded and
--   lenient variants
module Data.ByteString.Base64.URL

-- | Encode a <a>ByteString</a> value as a Base64url <a>Text</a> value with
--   padding.
--   
--   See: <a>RFC-4648 section 5</a>
encodeBase64 :: ByteString -> Text

-- | Encode a <a>ByteString</a> as a Base64url <a>ByteString</a> value with
--   padding.
--   
--   See: <a>RFC-4648 section 5</a>
encodeBase64' :: ByteString -> ByteString

-- | Decode a padded Base64url encoded <a>ByteString</a> value. If its
--   length is not a multiple of 4, then padding chars will be added to
--   fill out the input to a multiple of 4 for safe decoding as
--   Base64url-encoded values are optionally padded.
--   
--   For a decoder that fails on unpadded input of incorrect size, use
--   <a>decodeBase64Unpadded</a>.
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64 :: ByteString -> Either Text ByteString

-- | Encode a <a>ByteString</a> value as Base64url <a>Text</a> without
--   padding. Note that for Base64url, padding is optional. If you call
--   this function, you will simply be encoding as Base64url and stripping
--   padding chars from the output.
--   
--   See: <a>RFC-4648 section 3.2</a>
encodeBase64Unpadded :: ByteString -> Text

-- | Encode a <a>ByteString</a> value as Base64url without padding. Note
--   that for Base64url, padding is optional. If you call this function,
--   you will simply be encoding as Base64url and stripping padding chars
--   from the output.
--   
--   See: <a>RFC-4648 section 3.2</a>
encodeBase64Unpadded' :: ByteString -> ByteString

-- | Decode a padded Base64url-encoded <a>ByteString</a> value. If its
--   length is not a multiple of 4, then padding chars will <i>not</i> be
--   added to fill out the input to a multiple of 4.
--   
--   In general, unless unpadded Base64url is explicitly required, it is
--   safer to call <a>decodeBase64</a>.
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64Unpadded :: ByteString -> Either Text ByteString

-- | Leniently decode an unpadded Base64url-encoded <a>ByteString</a>. 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.
--   
--   <b>Note:</b> This is not RFC 4648-compliant.
decodeBase64Lenient :: ByteString -> ByteString

-- | Tell whether a <a>ByteString</a> is Base64url-encoded.
isBase64Url :: ByteString -> Bool

-- | Tell whether a <a>ByteString</a> is a valid Base64url 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 <a>ByteString</a> value, use
--   <a>isBase64Url</a>.
isValidBase64Url :: ByteString -> Bool


-- | This module contains the combinators implementing the RFC 4648
--   specification for the Base64 encoding including unpadded and lenient
--   variants
module Data.Text.Encoding.Base64

-- | Encode a <a>Text</a> value in Base64 with padding.
--   
--   See: <a>RFC-4648 section 4</a>
encodeBase64 :: Text -> Text

-- | Decode a padded Base64-encoded <a>Text</a> value
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64 :: Text -> Either Text Text

-- | Encode a <a>Text</a> value in Base64 without padding.
--   
--   <b>Note:</b> 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 <a>encodeBase64</a> 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: <a>RFC-4648 section 3.2</a>
encodeBase64Unpadded :: Text -> Text

-- | Decode an unpadded Base64-encoded <a>Text</a>
--   
--   See: <a>RFC-4648 section 3.2</a>
decodeBase64Unpadded :: Text -> Either Text Text

-- | Leniently decode a Base64-encoded <a>Text</a> 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.
--   
--   <b>Note:</b> This is not RFC 4648-compliant.
decodeBase64Lenient :: Text -> Text

-- | Tell whether a <a>Text</a> value is Base64-encoded.
isBase64 :: Text -> Bool

-- | Tell whether a <a>Text</a> 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 <a>Text</a> value, use
--   <a>isBase64</a>.
isValidBase64 :: Text -> Bool


-- | This module contains the combinators implementing the RFC 4648
--   specification for the Base64-URL encoding including unpadded and
--   lenient variants
module Data.Text.Encoding.Base64.URL

-- | Encode a <a>Text</a> value in Base64url with padding.
--   
--   See: <a>RFC-4648 section 5</a>
encodeBase64 :: Text -> Text

-- | Decode a padded Base64url-encoded <a>Text</a> value. If its length is
--   not a multiple of 4, then padding chars will be added to fill out the
--   input to a multiple of 4 for safe decoding as base64url encodings are
--   optionally padded.
--   
--   For a decoder that fails on unpadded input of incorrect size, use
--   <a>decodeBase64Unpadded</a>.
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64 :: Text -> Either Text Text

-- | Encode a <a>Text</a> value in Base64url without padding. Note that for
--   Base64url, padding is optional. If you call this function, you will
--   simply be encoding as Base64url and stripping padding chars from the
--   output.
--   
--   See: <a>RFC-4648 section 3.2</a>
encodeBase64Unpadded :: Text -> Text

-- | Decode an unpadded Base64url encoded <a>Text</a> value
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64Unpadded :: Text -> Either Text Text

-- | Leniently decode an unpadded Base64url-encoded <a>Text</a>. 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.
--   
--   <b>Note:</b> This is not RFC 4648-compliant.
decodeBase64Lenient :: Text -> Text

-- | Tell whether a <a>Text</a> value is Base64url-encoded.
isBase64Url :: Text -> Bool

-- | Tell whether a <a>Text</a> value is a valid Base64url 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 <a>Text</a> value, use
--   <a>isBase64Url</a>.
isValidBase64Url :: Text -> Bool