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


-- | Encoding and decoding for the Bottom spec.
--   
--   Encoding and decoding for the <a>Bottom spec</a>.
@package bottom
@version 0.2.0.0


-- | Encodes and decodes <a>Text</a>s to <a>Bottom</a>s. For details, see
--   the <a>Bottom spec</a>.
module Data.Encoding.Bottom

-- | A <a>Bottom</a> is a wrapper around well-formed, Bottom-encoded
--   <a>ByteString</a>. Its instances are derived from those of
--   <a>ByteString</a>.
data Bottom

-- | <a>unBottom</a> unwraps the underlying <a>ByteString</a>.
unBottom :: Bottom -> ByteString

-- | <a>encode</a> takes a <a>Text</a>, and encodes it into a
--   <a>Bottom</a>. To get at the underlying <a>ByteString</a>, unwrap the
--   returned value with <a>unBottom</a>.
encode :: Text -> Bottom

-- | <a>decode</a> decodes a <a>Bottom</a> into its corresponding Unicode
--   <a>Text</a>.
decode :: Bottom -> Text

-- | <a>decode'</a> decodes an arbitrary Bottom-encoded <a>ByteString</a>
--   into a <a>Text</a>, or returns a parse error message if the
--   <a>ByteString</a> is malformed.
decode' :: ByteString -> Either String Text
instance Control.DeepSeq.NFData Data.Encoding.Bottom.Bottom
instance GHC.Base.Monoid Data.Encoding.Bottom.Bottom
instance GHC.Base.Semigroup Data.Encoding.Bottom.Bottom
instance GHC.Classes.Ord Data.Encoding.Bottom.Bottom
instance GHC.Classes.Eq Data.Encoding.Bottom.Bottom
instance GHC.Show.Show Data.Encoding.Bottom.Bottom