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


-- | Classes to handle Prelude style IO functions for different datatypes
--   
--   The functions in the Prelude such as "getContents", "putStr" only work
--   for plain Strings.
--   
--   There are similar functions in <a>ByteString</a> for reading and
--   writing, as well as <a>Text</a>.
--   
--   This requires one to import the appropriate functions, usually
--   qualified, for the particular datatype one is using. Changing the
--   datatype at the very least involves changing import statements across
--   your program.
--   
--   The package introduces classes to overload functions like
--   "getContents", "putStr" over multiple datatypes, so implementations
--   can be changed easily.
--   
--   All the code documentation is in <a>System.IO.StringLike.Impl</a>.
--   
--   All the other modules are just re-exports.
@package io-string-like
@version 0.1.0.0


-- | The classes in this library roughly encapulates things you can read or
--   write through a "handle", typically writing something "string like" to
--   a file, but the interface is very flexible.
--   
--   Currently only <a>String</a>, <tt>ByteString</tt> and <tt>Text</tt> in
--   their strict/lazy varieties and builders are implemented.
--   
--   However, the interface has the flexibility to write non-character
--   data. For example an implementation for a <tt>[Int]</tt> could just
--   write all the <a>Int</a>s in binary to the file and read them back
--   into a <tt>[Int]</tt>.
--   
--   Also the interface can be defined for "handles" other than standard
--   files. Currently the only such instance that does not use
--   <a>Handle</a> is for <a>hGetContents</a>, where one can call directly:
--   
--   <pre>
--   hGetContents fileName
--   </pre>
--   
--   In this case, "handle" is a <a>FilePath</a>.
--   
--   The initial motivation of to avoid having to change all your function
--   calls if you change your string type, but it's actually more general
--   than that now.
--   
--   The point of this library is to be able to read and write raw data to
--   the disk (and perhaps other places) quickly without thinking too much
--   about it.
--   
--   It's not intended to be a replacement for say <tt>Binary</tt>. It's
--   intended to be lower level. <tt>Binary</tt> internally creates lazy
--   bytestrings for the user to write to the disk, this library is instead
--   just about directly writing raw data.
--   
--   Note that we currently only have classes for
--   
--   Most of the functions should be fairly self explanatory having the
--   same meaning as in <a>Prelude</a> or <a>System.IO</a> but more
--   general.
module System.IO.StringLike.Impl

-- | <a>CanGetContents</a> if effectively the following type synonym, for
--   the common case of an ordinary <a>Handle</a> in the <a>IO</a> monad
--   like so.
--   
--   <pre>
--   type CanGetContents t = CanGetContentsClass IO Handle t
--   </pre>
--   
--   The reason why it's defined as a class with a catch all instance
--   instead is so modules which use <a>CanGetContents</a> do not have to
--   include the language pragma <a>FleixbleContexts</a>.
--   
--   However, this approach requires this module to use the pragma
--   <a>UndecidableInstances</a>, but I figure it's better to add more
--   complexity to the library than to clients.
--   
--   <tt>CanGet</tt>, <a>CanGetLine</a>, <a>CanPutStr</a>,
--   <a>CanPutStrLn</a> all are similar synonyms with the same explanation
--   for their definition so I won't repeat myself.
class CanGetContentsClass IO Handle t => CanGetContents t
class Monad m => CanGetContentsClass m handleT t

-- | Generalised <a>hGetContents</a>
hGetContents :: CanGetContentsClass m handleT t => handleT -> m t

-- | Generalised <a>hGetContents</a>
hGetContents :: (CanGetContentsClass m handleT t, CanProxyFrom t, CanGetContentsClass m handleT (CanProxyT t)) => handleT -> m t
getContents :: CanGetContents t => IO t
readFile :: CanGetContents t => FilePath -> IO t

-- | Effective type synonym for <a>CanGetLineClass</a>. See
--   <a>CanGetContents</a> for more details.
class CanGetLineClass IO Handle t => CanGetLine t
class CanGetContentsClass m handleT t => CanGetLineClass m handleT t

-- | Generalised <a>hGetLine</a>
hGetLine :: CanGetLineClass m handleT t => handleT -> m t

-- | Generalised <a>hGetLine</a>
hGetLine :: (CanGetLineClass m handleT t, CanProxyFrom t, CanGetLineClass m handleT (CanProxyT t)) => handleT -> m t
getLine :: CanGetLine t => IO t

-- | Effective type synonym for <a>CanPutStrClass</a>. See
--   <a>CanGetContents</a> for more details.
class CanPutStrClass IO Handle t => CanPutStr t
class Monad m => CanPutStrClass m handleT t

-- | Generalised <a>hPutStr</a>
hPutStr :: CanPutStrClass m handleT t => handleT -> t -> m ()

-- | Generalised <a>hPutStr</a>
hPutStr :: (CanPutStrClass m handleT t, CanProxyTo t, CanPutStrClass m handleT (CanProxyT t)) => handleT -> t -> m ()
putStr :: CanPutStr t => t -> IO ()
writeFile :: CanPutStr t => FilePath -> t -> IO ()
appendFile :: CanPutStr t => FilePath -> t -> IO ()
interact :: (CanGetContents t, CanPutStr t) => (t -> t) -> IO ()

-- | Effective type synonym for <a>CanPutStrLnClass</a>. See
--   <a>CanGetContents</a> for more details.
class CanPutStrLnClass IO Handle t => CanPutStrLn t
class CanPutStrClass m handleT t => CanPutStrLnClass m handleT t

-- | Generalised <a>hPutStrLn</a>
hPutStrLn :: CanPutStrLnClass m handleT t => handleT -> t -> m ()

-- | Generalised <a>hPutStrLn</a>
hPutStrLn :: (CanPutStrLnClass m handleT t, CanProxyTo t, CanPutStrLnClass m handleT (CanProxyT t)) => handleT -> t -> m ()
putStrLn :: CanPutStrLn t => t -> IO ()

-- | If you have a data structure where in many cases the simplest way to
--   read or write to it is just convert it to another you should define an
--   instance of this class.
--   
--   For example, the simple way to write <tt>ByteString</tt>
--   <a>Builder</a>s is just to convert them to and from lazy
--   <tt>ByteString</tt>s.
--   
--   Defining classese <a>CanProxyTo</a> and <a>CanProxyFrom</a> will
--   define default methods for many of the other classes in this library.
--   These can still be overriden if desired but it will save you a lot of
--   boilerplate if you just which to convert your structure through some
--   other.
class CanProxyTo t

-- | How to convert to the type you will attempt to store
canProxyTo :: CanProxyTo t => t -> CanProxyT t
class CanProxyFrom t

-- | How to convert from the type you will attempt to store
canProxyFrom :: CanProxyFrom t => CanProxyT t -> t
instance System.IO.StringLike.Impl.CanGetContentsClass GHC.Types.IO GHC.IO.Handle.Types.Handle t => System.IO.StringLike.Impl.CanGetContents t
instance System.IO.StringLike.Impl.CanGetLineClass GHC.Types.IO GHC.IO.Handle.Types.Handle t => System.IO.StringLike.Impl.CanGetLine t
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle GHC.Base.String
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.ByteString.Internal.ByteString
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.ByteString.Lazy.Internal.ByteString
instance System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.ByteString.Lazy.Internal.ByteString => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.ByteString.Builder.Internal.Builder
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Text
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text
instance System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text => System.IO.StringLike.Impl.CanGetLineClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Builder.Builder
instance (m ~ GHC.Types.IO, System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle t) => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.FilePath t
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle GHC.Base.String
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.ByteString.Internal.ByteString
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.ByteString.Lazy.Internal.ByteString
instance (GHC.Base.Monad m, System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.ByteString.Lazy.Internal.ByteString) => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.ByteString.Builder.Internal.Builder
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Text
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text
instance (GHC.Base.Monad m, System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text) => System.IO.StringLike.Impl.CanGetContentsClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Builder.Builder
instance System.IO.StringLike.Impl.CanProxyFrom Data.ByteString.Builder.Internal.Builder
instance System.IO.StringLike.Impl.CanProxyFrom Data.Text.Internal.Builder.Builder
instance System.IO.StringLike.Impl.CanPutStrClass GHC.Types.IO GHC.IO.Handle.Types.Handle t => System.IO.StringLike.Impl.CanPutStr t
instance System.IO.StringLike.Impl.CanPutStrLnClass GHC.Types.IO GHC.IO.Handle.Types.Handle t => System.IO.StringLike.Impl.CanPutStrLn t
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle GHC.Base.String
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.ByteString.Internal.ByteString
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.ByteString.Lazy.Internal.ByteString
instance System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.ByteString.Builder.Internal.Builder => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.ByteString.Builder.Internal.Builder
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Text
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text
instance System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text => System.IO.StringLike.Impl.CanPutStrLnClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Builder.Builder
instance (m ~ GHC.Types.IO, System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle t) => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.FilePath t
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle GHC.Base.String
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.ByteString.Internal.ByteString
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.ByteString.Lazy.Internal.ByteString
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.ByteString.Builder.Internal.Builder
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Text
instance m ~ GHC.Types.IO => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text
instance (GHC.Base.Monad m, System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Lazy.Text) => System.IO.StringLike.Impl.CanPutStrClass m GHC.IO.Handle.Types.Handle Data.Text.Internal.Builder.Builder
instance System.IO.StringLike.Impl.CanProxyTo Data.ByteString.Builder.Internal.Builder
instance System.IO.StringLike.Impl.CanProxyTo Data.Text.Internal.Builder.Builder

module System.IO.StringLike.GetContents

-- | <a>CanGetContents</a> if effectively the following type synonym, for
--   the common case of an ordinary <a>Handle</a> in the <a>IO</a> monad
--   like so.
--   
--   <pre>
--   type CanGetContents t = CanGetContentsClass IO Handle t
--   </pre>
--   
--   The reason why it's defined as a class with a catch all instance
--   instead is so modules which use <a>CanGetContents</a> do not have to
--   include the language pragma <a>FleixbleContexts</a>.
--   
--   However, this approach requires this module to use the pragma
--   <a>UndecidableInstances</a>, but I figure it's better to add more
--   complexity to the library than to clients.
--   
--   <tt>CanGet</tt>, <a>CanGetLine</a>, <a>CanPutStr</a>,
--   <a>CanPutStrLn</a> all are similar synonyms with the same explanation
--   for their definition so I won't repeat myself.
class CanGetContentsClass IO Handle t => CanGetContents t
class Monad m => CanGetContentsClass m handleT t

-- | Generalised <a>hGetContents</a>
hGetContents :: CanGetContentsClass m handleT t => handleT -> m t

-- | Generalised <a>hGetContents</a>
hGetContents :: (CanGetContentsClass m handleT t, CanProxyFrom t, CanGetContentsClass m handleT (CanProxyT t)) => handleT -> m t
getContents :: CanGetContents t => IO t
readFile :: CanGetContents t => FilePath -> IO t
interact :: (CanGetContents t, CanPutStr t) => (t -> t) -> IO ()

module System.IO.StringLike.GetLine

-- | Effective type synonym for <a>CanGetLineClass</a>. See
--   <a>CanGetContents</a> for more details.
class CanGetLineClass IO Handle t => CanGetLine t
class CanGetContentsClass m handleT t => CanGetLineClass m handleT t

-- | Generalised <a>hGetLine</a>
hGetLine :: CanGetLineClass m handleT t => handleT -> m t

-- | Generalised <a>hGetLine</a>
hGetLine :: (CanGetLineClass m handleT t, CanProxyFrom t, CanGetLineClass m handleT (CanProxyT t)) => handleT -> m t
getLine :: CanGetLine t => IO t

module System.IO.StringLike.PutStr

-- | Effective type synonym for <a>CanPutStrClass</a>. See
--   <a>CanGetContents</a> for more details.
class CanPutStrClass IO Handle t => CanPutStr t
class Monad m => CanPutStrClass m handleT t

-- | Generalised <a>hPutStr</a>
hPutStr :: CanPutStrClass m handleT t => handleT -> t -> m ()

-- | Generalised <a>hPutStr</a>
hPutStr :: (CanPutStrClass m handleT t, CanProxyTo t, CanPutStrClass m handleT (CanProxyT t)) => handleT -> t -> m ()
putStr :: CanPutStr t => t -> IO ()
writeFile :: CanPutStr t => FilePath -> t -> IO ()
appendFile :: CanPutStr t => FilePath -> t -> IO ()
interact :: (CanGetContents t, CanPutStr t) => (t -> t) -> IO ()

module System.IO.StringLike.PutStrLn

-- | Effective type synonym for <a>CanPutStrLnClass</a>. See
--   <a>CanGetContents</a> for more details.
class CanPutStrLnClass IO Handle t => CanPutStrLn t
class CanPutStrClass m handleT t => CanPutStrLnClass m handleT t

-- | Generalised <a>hPutStrLn</a>
hPutStrLn :: CanPutStrLnClass m handleT t => handleT -> t -> m ()

-- | Generalised <a>hPutStrLn</a>
hPutStrLn :: (CanPutStrLnClass m handleT t, CanProxyTo t, CanPutStrLnClass m handleT (CanProxyT t)) => handleT -> t -> m ()
putStrLn :: CanPutStrLn t => t -> IO ()