Pdf.Toolbox.Core.IO

Basic IO operations for PDF

Documentation

type IS = InputStream ByteString

Sequential input stream

data RIS

Random access Input Stream

fromHandle :: Handle -> IO RIS

Create RIS from Handle with default chunk size

fromHandle' :: Handle -> Int -> IO RIS

Create RIS from Handle with the specified chunk size

class Monad m => MonadIO m where

Monads in which IO computations may be embedded. Any monad built by applying a sequence of monad transformers to the IO monad will be an instance of this class.

Instances should satisfy the following laws, which state that liftIO is a transformer of monads:

• liftIO . return = return

• liftIO (m >>= f) = liftIO m >>= (liftIO . f)

Methods

liftIO :: IO a -> m a

Lift a computation from the IO monad.

Instances

MonadIO IO

MonadIO (Generator r)

MonadIO (Consumer c)

MonadIO m => MonadIO (PdfWriter m)

MonadIO m => MonadIO (RandT g m)

MonadIO m => MonadIO (EitherT e m)

MonadIO m => MonadIO (EitherRT r m)

(Error e, MonadIO m) => MonadIO (ErrorT e m)

MonadIO m => MonadIO (StateT s m)

liftIO :: MonadIO m => forall a. IO a -> m a

Lift a computation from the IO monad.

size :: MonadIO m => RIS -> PdfE m Int64

Total number of bytes in RIS

seek :: MonadIO m => RIS -> Int64 -> PdfE m ()

Change input position in RIS

tell :: MonadIO m => RIS -> PdfE m Int64

Current input position

parse :: MonadIO m => Parser r -> IS -> PdfE m r

Parse from IS

inputStream :: MonadIO m => RIS -> PdfE m IS

Convert random access stream to sequential

takeBytes :: MonadIO m => Int64 -> IS -> PdfE m IS

See takeBytes

readExactly :: MonadIO m => Int -> IS -> PdfE m ByteString

See readExactly

dropExactly :: MonadIO m => Int -> IS -> PdfE m ()

Same as readExactly, but ignores the result