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


-- | RFC 4648-compliant Base16 encodings/decodings
--   
--   RFC 4648-compliant Base16 encodings and decodings. This library
--   provides performant encoding and decoding primitives, as well as
--   support for textual values.
@package base16
@version 0.1.2.1


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

-- | Encode a <a>ByteString</a> value as Base16 <a>Text</a> with padding.
--   
--   See: <a>RFC-4648 section 8</a>
encodeBase16 :: ByteString -> Text

-- | Encode a <a>ByteString</a> value as a Base16 <a>ByteString</a> value
--   with padding.
--   
--   See: <a>RFC-4648 section 8</a>
encodeBase16' :: ByteString -> ByteString

-- | Decode a padded Base16-encoded <a>ByteString</a> value.
--   
--   See: <a>RFC-4648 section 8</a>
decodeBase16 :: ByteString -> Either Text ByteString

-- | Tell whether a <a>ByteString</a> value is base16 encoded.
--   
--   Examples:
--   
--   This example will fail. It conforms to the alphabet, but is not valid
--   because it has an incorrect (odd) length.
--   
--   <pre>
--   &gt;&gt;&gt; isBase16 "666f6"
--   False
--   </pre>
--   
--   This example will succeed because it satisfies the alphabet and is
--   considered "valid" (i.e. of the correct size and shape).
--   
--   <pre>
--   &gt;&gt;&gt; isBase16 "666f"
--   True
--   </pre>
isBase16 :: ByteString -> Bool

-- | Tell whether a <a>ByteString</a> value is a valid Base16 format.
--   
--   This will not tell you whether or not this is a correct Base16
--   representation, only that it conforms to the correct alphabet. To
--   check whether it is a true Base16 encoded <a>ByteString</a> value, use
--   <a>isBase16</a>.
--   
--   Examples:
--   
--   This example will fail because it does not conform to the Hex
--   alphabet.
--   
--   <pre>
--   &gt;&gt;&gt; isValidBase16 "666f+/6"
--   False
--   </pre>
--   
--   This example will succeed because it satisfies the alphabet and is
--   considered "valid" (i.e. of the correct size and shape), but is not
--   correct base16 because it is the wrong shape.
--   
--   <pre>
--   &gt;&gt;&gt; isValidBase16 "666f6"
--   True
--   </pre>
isValidBase16 :: ByteString -> Bool


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

-- | Encode a <a>Text</a> value in Base16 with padding.
--   
--   See: <a>RFC-4648 section 8</a>
encodeBase16 :: Text -> Text

-- | Decode a padded Base16-encoded <a>Text</a> value
--   
--   See: <a>RFC-4648 section 8</a>
decodeBase16 :: Text -> Either Text Text

-- | Tell whether a <a>Text</a> value is Base16-encoded.
--   
--   Examples:
--   
--   This example will fail. It conforms to the alphabet, but is not valid
--   because it has an incorrect (odd) length.
--   
--   <pre>
--   &gt;&gt;&gt; isBase16 "666f6"
--   False
--   </pre>
--   
--   This example will succeed because it satisfies the alphabet and is
--   considered "valid" (i.e. of the correct size and shape).
--   
--   <pre>
--   &gt;&gt;&gt; isBase16 "666f"
--   True
--   </pre>
isBase16 :: Text -> Bool

-- | Tell whether a <a>Text</a> value is a valid Base16 format.
--   
--   This will not tell you whether or not this is a correct Base16
--   representation, only that it conforms to the correct shape. To check
--   whether it is a true Base16 encoded <a>Text</a> value, use
--   <a>isBase16</a>.
--   
--   Examples:
--   
--   This example will fail because it does not conform to the Hex
--   alphabet.
--   
--   <pre>
--   &gt;&gt;&gt; isValidBase16 "666f+/6"
--   False
--   </pre>
--   
--   This example will succeed because it satisfies the alphabet and is
--   considered "valid" (i.e. of the correct size and shape), but is not
--   correct base16 because it is the wrong shape.
--   
--   <pre>
--   &gt;&gt;&gt; isValidBase16 "666f6"
--   True
--   </pre>
isValidBase16 :: Text -> Bool