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


-- | Simple Utf8 wrapper for ByteString Builder with conversion classes
--   
--   Simple Utf8 wrapper for ByteString Builder with conversion classes.
--   Please see the README on GitHub at
--   <a>https://github.com/cdornan/render-utf8#readme</a>
@package render-utf8
@version 0.1.0.0

module Text.Utf8

-- | a UTF-8 encoded <a>ByteString</a> <a>Builder</a>
newtype Utf8
Utf8 :: Builder -> Utf8
[getUtf8] :: Utf8 -> Builder

-- | for converting Utf8 into other text types
class FromUtf8 a

-- | make a <a>Utf8</a> into whatever text type you need it to be
cvt :: FromUtf8 a => Utf8 -> a

-- | add a newline to the <a>Utf8</a> before converting it
cvtLn :: FromUtf8 a => Utf8 -> a

-- | for rendering things into Utf8
class Renderable a

-- | render <tt>a</tt> into a <a>Utf8</a>
render :: Renderable a => a -> Utf8

-- | render <tt>a</tt> into a <tt>Text</tt>
renderText :: Renderable a => a -> Text

-- | show into <a>Utf8</a>
renderShowable :: Show a => a -> Utf8

-- | Convert a <a>ByteString</a> into a <a>Utf8</a>; NB, if the
--   <tt>ByteString</tt> contains text using a non-UTF-8 encoding then 'bad
--   things' (TM) are liable to happen
unsafeInjectByteStringIntoUtf8 :: ByteString -> Utf8

-- | Convert a <a>Utf8</a> value into a strict <a>Text</a>.
utf8ToText :: Utf8 -> Text

-- | Convert a <a>Utf8</a> value into a lazy <a>Text</a>.
utf8ToLazyText :: Utf8 -> Text

-- | Write <a>Utf8</a> to file.
writeFileUtf8 :: MonadIO m => FilePath -> Utf8 -> m ()
instance GHC.Base.Monoid Text.Utf8.Utf8
instance GHC.Base.Semigroup Text.Utf8.Utf8
instance Fmt.Internal.Core.FromBuilder Text.Utf8.Utf8
instance Text.Utf8.Renderable Text.Utf8.Utf8
instance Text.Utf8.Renderable Data.Text.Internal.Text
instance Text.Utf8.Renderable Data.Text.Internal.Lazy.Text
instance Text.Utf8.Renderable Data.Text.Internal.Builder.Builder
instance Text.Utf8.Renderable GHC.Types.Char
instance Text.Utf8.Renderable GHC.Integer.Type.Integer
instance Text.Utf8.Renderable GHC.Types.Float
instance Text.Utf8.Renderable GHC.Types.Double
instance Text.Utf8.Renderable GHC.Types.Int
instance Text.Utf8.Renderable GHC.Int.Int8
instance Text.Utf8.Renderable GHC.Int.Int16
instance Text.Utf8.Renderable GHC.Int.Int32
instance Text.Utf8.Renderable GHC.Int.Int64
instance Text.Utf8.Renderable GHC.Types.Word
instance Text.Utf8.Renderable GHC.Word.Word8
instance Text.Utf8.Renderable GHC.Word.Word16
instance Text.Utf8.Renderable GHC.Word.Word32
instance Text.Utf8.Renderable GHC.Word.Word64
instance Text.Utf8.Renderable GHC.Exception.Type.SomeException
instance Text.Utf8.Renderable GHC.IO.Exception.IOException
instance Formatting.Buildable.Buildable Text.Utf8.Utf8
instance Text.Utf8.FromUtf8 Text.Utf8.Utf8
instance Text.Utf8.FromUtf8 Data.ByteString.Builder.Internal.Builder
instance Text.Utf8.FromUtf8 Data.Text.Internal.Builder.Builder
instance Text.Utf8.FromUtf8 Data.Text.Internal.Text
instance Text.Utf8.FromUtf8 Data.Text.Internal.Lazy.Text
instance Text.Utf8.FromUtf8 Data.ByteString.Internal.ByteString
instance Text.Utf8.FromUtf8 Data.ByteString.Lazy.Internal.ByteString
instance (a Data.Type.Equality.~ GHC.Types.Char) => Text.Utf8.FromUtf8 [a]
instance (a Data.Type.Equality.~ ()) => Text.Utf8.FromUtf8 (GHC.Types.IO a)
instance Data.String.IsString Text.Utf8.Utf8