pdf-toolbox-document-0.1.4: A collection of tools for processing PDF files.

Safe Haskell	Safe-Inferred
Language	Haskell2010

Pdf.Document.Pdf

Synopsis

data Pdf
withPdfFile :: FilePath -> (Pdf -> IO a) -> IO a
fromFile :: File -> IO Pdf
fromHandle :: Handle -> IO Pdf
fromBytes :: ByteString -> IO Pdf
document :: Pdf -> IO Document
lookupObject :: Pdf -> Ref -> IO Object
streamContent :: Pdf -> Ref -> Stream -> IO (InputStream ByteString)
rawStreamContent :: Pdf -> Ref -> Stream -> IO (InputStream ByteString)
deref :: Pdf -> Object -> IO Object
isEncrypted :: Pdf -> IO Bool
setUserPassword :: Pdf -> ByteString -> IO Bool
defaultUserPassword :: ByteString
data EncryptedError = EncryptedError Text
enableCache :: Pdf -> IO ()
disableCache :: Pdf -> IO ()

Documentation

data Pdf Source #

withPdfFile :: FilePath -> (Pdf -> IO a) -> IO a Source #

fromFile :: File -> IO Pdf Source #

Make Pdf with interface to pdf file

fromHandle :: Handle -> IO Pdf Source #

Make Pdf with seekable handle

fromBytes :: ByteString -> IO Pdf Source #

Make Pdf from a ByteString

document :: Pdf -> IO Document Source #

Get PDF document

lookupObject :: Pdf -> Ref -> IO Object Source #

Find object by it's reference

streamContent :: Pdf -> Ref -> Stream -> IO (InputStream ByteString) Source #

Get stream content, decoded and decrypted

Note: length of the content may differ from the raw one

rawStreamContent :: Pdf -> Ref -> Stream -> IO (InputStream ByteString) Source #

Get stream content without decoding it

deref :: Pdf -> Object -> IO Object Source #

isEncrypted :: Pdf -> IO Bool Source #

Whether the PDF document it encrypted

setUserPassword :: Pdf -> ByteString -> IO Bool Source #

Set the password to be user for decryption

Returns False when the password is wrong

defaultUserPassword :: ByteString #

The default user password

data EncryptedError Source #

File is enctypted

Constructors

EncryptedError Text

Instances

Instances details

Exception EncryptedError Source #
Instance details Defined in Pdf.Document.Pdf Methods toException :: EncryptedError -> SomeException # fromException :: SomeException -> Maybe EncryptedError # displayException :: EncryptedError -> String #
Show EncryptedError Source #
Instance details Defined in Pdf.Document.Pdf Methods showsPrec :: Int -> EncryptedError -> ShowS # show :: EncryptedError -> String # showList :: [EncryptedError] -> ShowS #

enableCache :: Pdf -> IO () Source #

Cache object for future lookups

disableCache :: Pdf -> IO () Source #

Don't cache object for future lookups