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


-- | Data encoding library
--   
--   Data encoding library currently providing Uuencode, Base64, Base64Url,
--   Base32, Base32Hex, and Base16.
@package dataenc
@version 0.10.2


-- | Uuencoding module.
--   
--   Uuencoding is notoriously badly specified. This implementation is
--   compatible with the GNU Sharutils
--   (<a>http://www.gnu.org/software/sharutils/</a>).
module Codec.Binary.Uu

-- | Encode data.
encode :: [Word8] -> String

-- | Decode data (strict).
decode :: String -> Maybe [Word8]

-- | Decode data (lazy).
decode' :: String -> [Maybe Word8]

-- | Chop up a string in parts. Each string in the resulting list is
--   prepended with the length according to the uuencode "specificiation".
--   
--   <i>Notes:</i>
--   
--   <ul>
--   <li>The length of the strings in the result will be <tt>(n -1)
--   <a>div</a> 4 * 4</tt>. The <tt>-1</tt> comes from the need to prepend
--   the length. Keeping it to a multiple of 4 means that strings returned
--   from <a>encode</a> can be chopped without requiring any changes.</li>
--   <li>The length of lines in GNU's sharutils is 61.</li>
--   </ul>
chop :: Int -> String -> [String]

-- | Concatenate the strings into one long string. Each string is assumed
--   to be prepended with the length according to the uuencode
--   specification.
unchop :: [String] -> String


-- | Base64 module.
--   
--   Implemented as specified in RFC 4648
--   (<a>http://tools.ietf.org/html/rfc4648</a>).
module Codec.Binary.Base64

-- | Encode data.
encode :: [Word8] -> String

-- | Decode data (strict).
decode :: String -> Maybe [Word8]

-- | Decode data (lazy).
decode' :: String -> [Maybe Word8]

-- | Chop up a string in parts.
--   
--   The length given is rounded down to the nearest multiple of 4.
--   
--   <i>Notes:</i>
--   
--   <ul>
--   <li>PEM requires lines that are 64 characters long.</li>
--   <li>MIME requires lines that are at most 76 characters long.</li>
--   </ul>
chop :: Int -> String -> [String]

-- | Concatenate the strings into one long string.
unchop :: [String] -> String


-- | Base64Url module.
--   
--   Implemented as specified in RFC 4648
--   (<a>http://tools.ietf.org/html/rfc4648</a>).
module Codec.Binary.Base64Url

-- | Encode data.
encode :: [Word8] -> String

-- | Decode data (strict).
decode :: String -> Maybe [Word8]

-- | Decode data (lazy).
decode' :: String -> [Maybe Word8]

-- | Chop up a string in parts.
--   
--   See <a>chop</a> in <a>Base64</a> for more details.
chop :: Int -> String -> [String]

-- | Concatenate the strings into one long string.
--   
--   See <a>unchop</a> in <a>Codec.Binary.Base64</a> for more details.
unchop :: [String] -> String


-- | Base32 module.
--   
--   Implemented as specified in RFC 4648
--   (<a>http://tools.ietf.org/html/rfc4648</a>).
module Codec.Binary.Base32

-- | Encode data.
encode :: [Word8] -> String

-- | Decode data (strict).
decode :: String -> Maybe [Word8]

-- | Decode data (lazy).
decode' :: String -> [Maybe Word8]

-- | Chop up a string in parts.
--   
--   The length given is rounded down to the nearest multiple of 8.
chop :: Int -> String -> [String]

-- | Concatenate the strings into one long string.
unchop :: [String] -> String


-- | Base32Hex module.
--   
--   Implemented as specified in RFC 4648
--   (<a>http://tools.ietf.org/html/rfc4648</a>).
module Codec.Binary.Base32Hex

-- | Encode data.
encode :: [Word8] -> String

-- | Decode data (strict).
decode :: String -> Maybe [Word8]

-- | Decode data (lazy).
decode' :: String -> [Maybe Word8]

-- | Chop up a string in parts.
--   
--   See <a>chop</a> in <a>Base32</a> for more details.
chop :: Int -> String -> [String]

-- | Concatenate the strings into one long string.
--   
--   See <a>unchop</a> in <a>Codec.Binary.Base32</a> for more details.
unchop :: [String] -> String


-- | Base16 module.
--   
--   Implemented as specified in RFC 4648
--   (<a>http://tools.ietf.org/html/rfc4648</a>).
module Codec.Binary.Base16

-- | Encode data.
encode :: [Word8] -> String

-- | Decode data (strict).
decode :: String -> Maybe [Word8]

-- | Decode data (lazy).
decode' :: String -> [Maybe Word8]

-- | Chop up a string in parts.
--   
--   The length given is rounded down to the nearest multiple of 2.
chop :: Int -> String -> [String]

-- | Concatenate the strings into one long string.
unchop :: [String] -> String


-- | Data encoding module.
--   
--   It exposes several instances of <a>DataCodec</a>, one for each data
--   encoding implemented in the library without causing the name clashing
--   that would result from importing the individual encoding modules.
module Codec.Binary.DataEncoding

-- | Used to group a specific data encoding's functions.
data DataCodec
encode :: DataCodec -> [Word8] -> String
decode :: DataCodec -> String -> Maybe [Word8]
decode' :: DataCodec -> String -> [Maybe Word8]
chop :: DataCodec -> Int -> String -> [String]
unchop :: DataCodec -> [String] -> String

-- | Base16 encoding, see <a>Codec.Binary.Base16</a> for more details on
--   the individual functions.
base16 :: DataCodec

-- | Base32 encoding, see <a>Codec.Binary.Base32</a> for more details on
--   the individual functions.
base32 :: DataCodec

-- | Base32Hex encoding, see <a>Codec.Binary.Base32Hex</a> for more details
--   on the individual functions.
base32Hex :: DataCodec

-- | Base64 encoding, see <a>Codec.Binary.Base64</a> for more details on
--   the individual functions.
base64 :: DataCodec

-- | Base64Url encoding, see <a>Codec.Binary.Base64Url</a> for more details
--   on the individual functions.
base64Url :: DataCodec

-- | Uuencoding, see <a>Codec.Binary.Uu</a> for more details on the
--   individual functions.
uu :: DataCodec