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


-- | Display things for humans to read
--   
--   Efficiently display things for humans to read
@package display
@version 0.0.1


-- | Display human-readable values to the user efficiently. See the
--   <a>display</a> method for documentation.
--   
--   Use the OverloadedStrings language extension when using this module to
--   produce <tt>Builder</tt> values conveniently e.g. <tt>"Hello" &lt;&gt;
--   display name</tt>.
module Display

-- | Display a value in a human-readable format. This is the opposite of
--   the <a>Show</a> class which is intended for programmers to read. See
--   <a>Display</a> for how to use this for your own types.
--   
--   <ul>
--   <li>Writing to file or output: The <a>Builder</a> can be written
--   directly to a handle with <a>hPutBuilder</a> very efficiently as
--   UTF-8. This is the preferred method when writing to stdout or a
--   file.</li>
--   <li>Writing to a string: Use one of the functions in Conversions like
--   <a>displayByteString</a> or <a>displayString</a> (when needed).</li>
--   </ul>
--   
--   Use the functions in <a>Data.ByteString.Builder</a> for hex encodings
--   of numbers and strings.
--   
--   To append <tt>Builder</tt> you can use the <a>Monoid</a> instance, for
--   example to print things comma-separated, you can use
--   <a>intersperse</a> and <a>mconcat</a>:
--   
--   <pre>
--   mconcat (intersperse ", " (map display [1, 4, 5]))
--   </pre>
--   
--   This example requires the OverloadedStrings language extension.
display :: Display a => a -> Builder

-- | Display to a <a>ByteString</a> value.
displayByteString :: Display a => a -> ByteString

-- | Display to a <a>ByteString</a> value.
displayLazyByteString :: Display a => a -> ByteString

-- | Display to a <a>String</a> value. Very inefficient. Only use when you
--   are forced to by another API.
displayString :: Display a => a -> String

-- | Display to a <a>Text</a> value. Inefficient. Only use when you have
--   to.
displayText :: Display a => a -> Text

-- | Display to a <a>Text</a> value. Inefficient. Only use when you have
--   to.
displayLazyText :: Display a => a -> Text

-- | Display a value in a human-readable format. This is the opposite of
--   the <a>Show</a> class which is intended for programmers to read, and
--   can be used alongside <a>Show</a>.
--   
--   For example, consider: <tt>Maybe String</tt>
--   
--   <pre>
--   &gt;&gt;&gt; show (Just "abc")
--   Just "abc"
--   
--   &gt;&gt;&gt; show Nothing
--   Nothing
--   </pre>
--   
--   whereas <a>display</a> is meant for printing to users, so you might
--   write this:
--   
--   <pre>
--   &gt;&gt;&gt; display (Just "abc")
--   abc
--   
--   &gt;&gt;&gt; display Nothing
--   ""
--   </pre>
--   
--   You can safely use newtype deriving with this type, e.g.
--   
--   <pre>
--   newtype Name = Name Text deriving (Show, Display)
--   </pre>
--   
--   Instances for exceptions can be written like this:
--   
--   <pre>
--   data MyException = SomeProblem deriving (Show, Typeable)
--   instance Exception MyException where displayException = displayString
--   </pre>
class Display a

-- | Display a value in a human-readable format. This is the opposite of
--   the <a>Show</a> class which is intended for programmers to read. See
--   <a>Display</a> for how to use this for your own types.
--   
--   <ul>
--   <li>Writing to file or output: The <a>Builder</a> can be written
--   directly to a handle with <a>hPutBuilder</a> very efficiently as
--   UTF-8. This is the preferred method when writing to stdout or a
--   file.</li>
--   <li>Writing to a string: Use one of the functions in Conversions like
--   <a>displayByteString</a> or <a>displayString</a> (when needed).</li>
--   </ul>
--   
--   Use the functions in <a>Data.ByteString.Builder</a> for hex encodings
--   of numbers and strings.
--   
--   To append <tt>Builder</tt> you can use the <a>Monoid</a> instance, for
--   example to print things comma-separated, you can use
--   <a>intersperse</a> and <a>mconcat</a>:
--   
--   <pre>
--   mconcat (intersperse ", " (map display [1, 4, 5]))
--   </pre>
--   
--   This example requires the OverloadedStrings language extension.
display :: Display a => a -> Builder
instance Display.Display a => Display.Display (GHC.Base.Maybe a)
instance (Display.Display a, Display.Display b) => Display.Display (Data.Either.Either a b)
instance Display.Display Data.Text.Internal.Text
instance Display.Display Data.Text.Internal.Lazy.Text
instance Display.Display Data.ByteString.Builder.Internal.Builder
instance Display.Display Data.ByteString.Internal.ByteString
instance Display.Display Data.ByteString.Lazy.Internal.ByteString
instance Display.Display [GHC.Types.Char]
instance Display.Display GHC.Types.Char
instance Display.Display GHC.Int.Int8
instance Display.Display GHC.Int.Int16
instance Display.Display GHC.Int.Int32
instance Display.Display GHC.Int.Int64
instance Display.Display GHC.Types.Int
instance Display.Display GHC.Integer.Type.Integer
instance Display.Display GHC.Word.Word8
instance Display.Display GHC.Word.Word16
instance Display.Display GHC.Word.Word32
instance Display.Display GHC.Word.Word64
instance Display.Display GHC.Types.Word
instance Display.Display GHC.Types.Float
instance Display.Display GHC.Types.Double