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


-- | This module contains the combinators implementing the RFC 4648
--   specification for the Base16 encoding including unpadded and lenient
--   variants for bytestrings
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 Base16-encoded <a>ByteString</a> value.
--   
--   See: <a>RFC-4648 section 8</a>
decodeBase16 :: ByteString -> Either Text ByteString

-- | Decode a Base16-encoded <a>ByteString</a> value leniently, using a
--   strategy that never fails
--   
--   N.B.: this is not RFC 4648-compliant
decodeBase16Lenient :: ByteString -> 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 for lazy bytestrings
module Data.ByteString.Lazy.Base16

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

-- | Encode a lazy <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 lazy <a>ByteString</a> value.
--   
--   See: <a>RFC-4648 section 8</a>
decodeBase16 :: ByteString -> Either Text ByteString

-- | Decode a Base16-encoded <a>ByteString</a> value leniently, using a
--   strategy that never fails
--   
--   N.B.: this is not RFC 4648-compliant. It may give you garbage if
--   you're not careful!
decodeBase16Lenient :: ByteString -> ByteString

-- | Tell whether a lazy <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 lazy <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 error types raised (not as exceptions!) in
--   the decoding process.
module Data.Text.Encoding.Base16.Error

-- | This data type represents the type of decoding errors of various kinds
--   as they pertain to decoding <a>Text</a> values. Namely, to distinguish
--   between decoding errors from opaque unicode exceptions caught in the
--   unicode decoding process.
data Base16Error e

-- | The error associated with decoding failure as a result of the Base16
--   decoding process
DecodeError :: Text -> Base16Error e

-- | The error associated with the decoding failure as a result of the
--   conversion process
ConversionError :: e -> Base16Error e
instance GHC.Show.Show e => GHC.Show.Show (Data.Text.Encoding.Base16.Error.Base16Error e)
instance GHC.Classes.Eq e => GHC.Classes.Eq (Data.Text.Encoding.Base16.Error.Base16Error e)


-- | This module contains the combinators implementing the RFC 4648
--   specification for the Base16 encoding including unpadded and lenient
--   variants for text values
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 Base16-encoded lazy <a>Text</a> value.
--   
--   See: <a>RFC-4648 section 8</a>
decodeBase16 :: Text -> Either Text Text

-- | Attempt to decode a lazy <a>Text</a> value as Base16, converting from
--   <a>ByteString</a> to <a>Text</a> according to some encoding function.
--   In practice, This is something like <tt>decodeUtf8'</tt>, which may
--   produce an error.
--   
--   See: <a>RFC-4648 section 8</a>
--   
--   Example:
--   
--   <pre>
--   <a>decodeBase16With</a> <a>decodeUtf8'</a>
--     :: <a>Text</a> -&gt; <a>Either</a> (<a>Base16Error</a> <tt>UnicodeException</tt>) <a>Text</a>
--   </pre>
decodeBase16With :: (ByteString -> Either err Text) -> Text -> Either (Base16Error err) Text

-- | Decode a Base16-encoded lazy <a>Text</a> value leniently, using a
--   strategy that never fails, catching unicode exceptions raised in the
--   process of converting to text values.
--   
--   N.B.: this is not RFC 4648-compliant.
decodeBase16Lenient :: 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


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

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

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

-- | Attempt to decode a lazy <a>Text</a> value as Base16, converting from
--   <a>ByteString</a> to <a>Text</a> according to some encoding function.
--   In practice, This is something like <tt>decodeUtf8'</tt>, which may
--   produce an error.
--   
--   See: <a>RFC-4648 section 8</a>
--   
--   Example:
--   
--   <pre>
--   <a>decodeBase16With</a> <a>decodeUtf8'</a>
--     :: <a>Text</a> -&gt; <a>Either</a> (<a>Base16Error</a> <tt>UnicodeException</tt>) <a>Text</a>
--   </pre>
decodeBase16With :: (ByteString -> Either err Text) -> Text -> Either (Base16Error err) Text

-- | Decode a Base16-encoded lazy <a>Text</a> value leniently, using a
--   strategy that never fails.
--   
--   <i>Warning</i>: in the conversion to unicode text, exceptions may be
--   thrown. Please use <tt>decodeBase16'</tt> if you are unsure if you are
--   working with base16-encoded values, or if you expect garbage.
--   
--   N.B.: this is not RFC 4648-compliant. It may give you garbage if
--   you're not careful!
decodeBase16Lenient :: Text -> Text

-- | Tell whether a lazy <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 lazy <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