Pdf.Toolbox.Document.Pdf

Basic implementation of pdf monad

Documentation

type Pdf m = PdfE (Pdf' m)

Convenient type alias

data Pdf' m a

Basic implementation of pdf monad

Instances

MonadTrans Pdf'

Monad m => Monad (Pdf' m)

Functor m => Functor (Pdf' m)

MonadIO m => MonadIO (Pdf' m)

MonadIO m => MonadPdf (Pdf' m)

runPdf :: MonadIO m => RIS -> [StreamFilter] -> Pdf m a -> m (Either PdfError a)

Execute PDF action with RIS

runPdfWithHandle :: MonadIO m => Handle -> [StreamFilter] -> Pdf m a -> m (Either PdfError a)

Execute PDF action with Handle

document :: MonadIO m => Pdf m Document

Get PDF document

flushObjectCache :: Monad m => Pdf m ()

Remove all objects from cache

withoutObjectCache :: Monad m => Pdf m () -> Pdf m ()

Perform action without adding objects to cache. Note: the existent cache is not flushed, and is used within the action

getRIS :: Monad m => Pdf m RIS

Access to the underlying random access input stream. Can be used when you need to switch from high level to low level of details

knownFilters :: [StreamFilter]

All stream filters implemented by the toolbox

Right now it contains only FlateDecode filter

isEncrypted :: MonadIO m => Pdf m Bool

Whether the PDF document it encrypted

setUserPassword :: MonadIO m => ByteString -> Pdf m ()

Set the password to be user for decryption

defaultUserPassord :: ByteString

The default user password

decrypt :: MonadIO m => Ref -> Object a -> Pdf m (Object a)

Decrypt PDF object using user password is set

getDecryptor :: Monad m => Pdf m (Maybe Decryptor)

Decryptor

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 (Pdf' m)

MonadIO m => MonadIO (RandT g m)

MonadIO m => MonadIO (EitherT e m)

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

MonadIO m => MonadIO (StateT s m)