-- 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.2.0.0


-- | 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> in base64 with padding.
--   
--   See: <a>RFC-4648 section 4</a>
encodeBase64 :: ByteString -> ByteString

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

-- | Encode a <a>ByteString</a> 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 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 in
--   the form of "NUL".
--   
--   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>
--   
--   See: <a>RFC-4648 section 3.2</a>
decodeBase64Unpadded :: ByteString -> Either Text ByteString


-- | 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> in base64-url with padding.
--   
--   See: <a>RFC-4648 section 5</a>
encodeBase64 :: ByteString -> ByteString

-- | Decode a padded base64-url encoded <a>ByteString</a>
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64 :: ByteString -> Either Text ByteString

-- | Encode a <a>ByteString</a> in base64-url without padding.
--   
--   Note: in some circumstances, the use of padding ("=") in base-encoded
--   data is not required or used. If you are absolutely sure the length of
--   your input data 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 output in the form of "NUL".
--   
--   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-url encoded <a>ByteString</a>
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64Unpadded :: ByteString -> Either Text ByteString


-- | 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>Text</a> 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> in base64 without padding.
--   
--   Note: in some circumstances, the use of padding ("=") in base-encoded
--   data is not required or used. If you are absolutely sure the length of
--   your input data 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 output in the form of "NUL".
--   
--   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


-- | 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> in base64-url with padding.
--   
--   See: <a>RFC-4648 section 5</a>
encodeBase64 :: Text -> Text

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

-- | Encode a <a>Text</a> value in base64-url without padding.
--   
--   <b>Note:</b> in some circumstances, the use of padding ("=") in
--   base-encoded data is not required or used. If you are absolutely sure
--   the length of your input data 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 output in the form of "NUL".
--   
--   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-url encoded <a>Text</a> value
--   
--   See: <a>RFC-4648 section 4</a>
decodeBase64Unpadded :: Text -> Either Text Text