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


-- | Read and write values of types that implement Binary
--   
--   Read and write values of types that implement Binary
--   
--   See module <a>Data.Binary.IO.Lifted</a>.
@package binary-io
@version 0.6.1


-- | Read and write values of types that implement <a>Binary</a>.
module Data.Binary.IO.Lifted

-- | An error that can occur during reading
data ReaderError

-- | Error from the <a>Get</a> operation
ReaderGetError :: !ByteString -> !ByteOffset -> !ByteString -> !String -> ReaderError

-- | Unconsumed part of the byte stream
[readerErrorRemaining] :: ReaderError -> !ByteString

-- | Error location represented as an offset into the input
[readerErrorOffset] :: ReaderError -> !ByteOffset

-- | Input to the <a>Get</a> operation
[readerErrorInput] :: ReaderError -> !ByteString

-- | Error message
[readerErrorMessage] :: ReaderError -> !String

newtype Reader m
Reader :: (forall a. Get a -> m a) -> Reader m
[runReader] :: Reader m -> forall a. Get a -> m a

-- | Create a new reader.
--   
--   Inherits properties from <a>newReaderWith</a>.
--   
--   Other threads reading from the <a>Handle</a> will interfere with read
--   operations of the <a>Reader</a>. However, the <a>Reader</a> itself is
--   thread-safe and can be utilized concurrently.
--   
--   The given <a>Handle</a> will be swiched to binary mode via
--   <a>hSetBinaryMode</a>.
newReader :: (MonadConc m, MonadIO m) => Handle -> m (Reader m)

-- | Create a new <a>Reader</a> using an action that provides the chunks.
--   
--   The chunk producers indicates the end of the stream by returning an
--   empty <a>ByteString</a>.
--   
--   Reading using the <a>Reader</a> may throw <a>ReaderError</a>.
--   
--   The internal position of the <a>Reader</a> is not advanced when it
--   throws an exception during reading. This has the consequence that if
--   you're trying to read with the same faulty <a>Get</a> operation
--   multiple times, you will always receive an exception.
--   
--   The <a>Reader</a> is safe to use concurrently.
newReaderWith :: MonadConc m => m ByteString -> m (Reader m)

-- | Transform the underlying functor.
mapReader :: (forall a. m a -> n a) -> Reader m -> Reader n

newtype Writer m
Writer :: (forall a. PutM a -> m a) -> Writer m
[runWriter] :: Writer m -> forall a. PutM a -> m a

-- | Create a writer.
--   
--   Other threads writing to the same <a>Handle</a> do not interfere with
--   the resulting <a>Writer</a>. The <a>Writer</a> may be used
--   concurrently.
newWriter :: MonadIO m => Handle -> Writer m

-- | Create a writer using a function that handles the output chunks.
newWriterWith :: Applicative m => (ByteString -> m ()) -> Writer m

-- | Transform the underlying functor.
mapWriter :: (forall x. m x -> n x) -> Writer m -> Writer n

-- | Create a connected pair of <a>Reader</a> and <a>Writer</a>.
--   
--   The <a>Reader</a> will automatically end the stream if the
--   <a>Writer</a> goes out of scope.
newPipe :: (MonadConc m, MonadIO m) => m (Reader m, Writer m)

-- | Pair of <a>Reader</a> and <a>Writer</a>
data Duplex m
Duplex :: Writer m -> Reader m -> Duplex m
[duplexWriter] :: Duplex m -> Writer m
[duplexReader] :: Duplex m -> Reader m

-- | Create a new duplex. The <a>Duplex</a> inherits all the properties of
--   <a>Reader</a> and <a>Writer</a> when created with <a>newReader</a> and
--   <a>newWriter</a>.
newDuplex :: (MonadConc m, MonadIO m) => Handle -> m (Duplex m)

-- | Combines <a>newReaderWith</a> and <a>newWriterWith</a>.
newDuplexWith :: MonadConc m => m ByteString -> (ByteString -> m ()) -> m (Duplex m)

-- | Transform the underlying functor.
mapDuplex :: (forall a. m a -> n a) -> Duplex m -> Duplex n

-- | <tt>r</tt> can execute <a>Get</a> operations in <tt>m</tt>
class CanGet r m
runGet :: CanGet r m => r -> Get a -> m a

-- | Read something from <tt>r</tt>. Inherits properties from
--   <a>runGet</a>.
read :: (CanGet r m, Binary a) => r -> m a

-- | Check if there is no more input to consume. This function may block.
--   All properties of <a>runGet</a> apply to this function as well.
isEmpty :: CanGet r m => r -> m Bool

-- | <tt>w</tt> can execute <a>Put</a> operations in <tt>m</tt>
class CanPut w m
runPut :: CanPut w m => w -> PutM a -> m a

-- | Write something to <tt>w</tt>.
write :: (CanPut w m, Binary a) => w -> a -> m ()
instance GHC.Exception.Type.Exception Data.Binary.IO.Lifted.ReaderError
instance GHC.Show.Show Data.Binary.IO.Lifted.ReaderError
instance Data.Binary.IO.Lifted.CanGet (Data.Binary.IO.Lifted.Duplex m) m
instance Data.Binary.IO.Lifted.CanPut (Data.Binary.IO.Lifted.Duplex m) m
instance Data.Binary.IO.Lifted.CanPut (Data.Binary.IO.Lifted.Writer m) m
instance Control.Monad.IO.Class.MonadIO m => Data.Binary.IO.Lifted.CanPut GHC.IO.Handle.Types.Handle m
instance Data.Binary.IO.Lifted.CanGet (Data.Binary.IO.Lifted.Reader m) m


-- | Read and write values of types that implement <a>Binary</a> from and
--   to <a>Handle</a>s
--   
--   This module homes the unlifted API variant. For proper documentation
--   check out the equally named functions in <a>Data.Binary.IO.Lifted</a>
module Data.Binary.IO

-- | An error that can occur during reading
data ReaderError

-- | Error from the <a>Get</a> operation
ReaderGetError :: !ByteString -> !ByteOffset -> !ByteString -> !String -> ReaderError

-- | Unconsumed part of the byte stream
[readerErrorRemaining] :: ReaderError -> !ByteString

-- | Error location represented as an offset into the input
[readerErrorOffset] :: ReaderError -> !ByteOffset

-- | Input to the <a>Get</a> operation
[readerErrorInput] :: ReaderError -> !ByteString

-- | Error message
[readerErrorMessage] :: ReaderError -> !String

-- | Alias for <a>Reader</a> <a>IO</a>
newtype Reader
Reader :: Reader IO -> Reader
[unReader] :: Reader -> Reader IO

-- | Unlifted version of <a>newReader</a>
newReader :: Handle -> IO Reader

-- | Unlifted version of <a>newReaderWith</a>.
newReaderWith :: IO ByteString -> IO Reader

newtype Writer
Writer :: Writer IO -> Writer
[unWriter] :: Writer -> Writer IO

-- | Unlifted version of <a>newWriter</a>
newWriter :: Handle -> Writer

-- | Unlifted version of <a>newWriterWith</a>
newWriterWith :: (ByteString -> IO ()) -> Writer

-- | Unlifted version of <a>newPipe</a>
newPipe :: IO (Reader, Writer)

data Duplex
Duplex :: !Writer -> !Reader -> Duplex
[duplexWriter] :: Duplex -> !Writer
[duplexReader] :: Duplex -> !Reader

-- | Unlifted version of <a>newDuplex</a>
newDuplex :: Handle -> IO Duplex

-- | Unlifted version of <a>newDuplexWith</a>
newDuplexWith :: IO ByteString -> (ByteString -> IO ()) -> IO Duplex

-- | Alias for <a>CanGet</a> <tt>r</tt> <a>IO</a>
type CanGet r = CanGet r IO

-- | Unlifted version of <a>runGet</a>
runGet :: CanGet r => r -> Get a -> IO a

-- | Unlifted version of <a>read</a>
read :: (CanGet r, Binary a) => r -> IO a

-- | Unlifted version of <a>isEmpty</a>
isEmpty :: CanGet r => r -> IO Bool

-- | Alias for <a>CanPut</a> <tt>w</tt> <a>IO</a>
type CanPut w = CanPut w IO

-- | Unlifted version of <a>runPut</a>
runPut :: CanPut w => w -> PutM a -> IO a

-- | Unlifted version of <a>write</a>
write :: (CanPut w, Binary a) => w -> a -> IO ()
instance Data.Binary.IO.Lifted.CanGet Data.Binary.IO.Duplex GHC.Types.IO
instance Data.Binary.IO.Lifted.CanPut Data.Binary.IO.Duplex GHC.Types.IO
instance Data.Binary.IO.Lifted.CanPut Data.Binary.IO.Writer GHC.Types.IO
instance Data.Binary.IO.Lifted.CanGet Data.Binary.IO.Reader GHC.Types.IO