Pdf.Core.File

Pdf file as a set of objects

Documentation

data File

Pdf file is a collection of Objects

Constructors

File

Fields

• fileLastXRef :: XRef
• fileBuffer :: Buffer
• fileFilters :: [StreamFilter]
• fileDecryptor :: IORef (Maybe Decryptor)

withPdfFile :: FilePath -> (File -> IO a) -> IO a

Open Pdf file

You may want to check encryptionStatus and setUserPassword if file is encrypted.

fromHandle :: [StreamFilter] -> Handle -> IO File

Create file from a binary handle.

You may use knownFilters as the first argument.

fromBytes :: [StreamFilter] -> ByteString -> IO File

Create file from a ByteString.

You may use knownFilters as the first argument.

fromBuffer :: [StreamFilter] -> Buffer -> IO File

Create file from a buffer.

You may use knownFilters as the first argument.

lastTrailer :: File -> IO Dict

The last trailer is an entry point to PDF file. All other objects usually are referensed from it, directly or indirectly.

findObject :: File -> Ref -> IO Object

Get an object with the specified ref.

streamContent :: File -> Ref -> Stream -> IO (InputStream ByteString)

Get content of the stream

It's decrypted and decoded using registered StreamFilters if necessary.

rawStreamContent :: File -> Ref -> Stream -> IO (InputStream ByteString)

Get content of the stream

Content would be decrypted if necessary.

data EncryptionStatus

Describes wether PDF file is encrypted, plain or already decrypted

Constructors

Encrypted

requires decryption

Decrypted

already decrypted

Plain

doesn't require decryption

Instances

Enum EncryptionStatus

Defined in Pdf.Core.File

Methods

succ :: EncryptionStatus -> EncryptionStatus

pred :: EncryptionStatus -> EncryptionStatus

toEnum :: Int -> EncryptionStatus

fromEnum :: EncryptionStatus -> Int

enumFrom :: EncryptionStatus -> [EncryptionStatus]

enumFromThen :: EncryptionStatus -> EncryptionStatus -> [EncryptionStatus]

enumFromTo :: EncryptionStatus -> EncryptionStatus -> [EncryptionStatus]

enumFromThenTo :: EncryptionStatus -> EncryptionStatus -> EncryptionStatus -> [EncryptionStatus]

Show EncryptionStatus

Defined in Pdf.Core.File

Methods

showsPrec :: Int -> EncryptionStatus -> ShowS

show :: EncryptionStatus -> String

showList :: [EncryptionStatus] -> ShowS

Eq EncryptionStatus

Defined in Pdf.Core.File

Methods

(==) :: EncryptionStatus -> EncryptionStatus -> Bool

(/=) :: EncryptionStatus -> EncryptionStatus -> Bool

encryptionStatus :: File -> IO EncryptionStatus

Get encryption status.

If it's Encrypted, you may want to setUserPassword to decrypt it.

setUserPassword :: File -> ByteString -> IO Bool

Set user password to decrypt PDF file.

Use empty bytestring to set the default password. Returns True on success. See also setDecryptor.

setDecryptor :: File -> Decryptor -> IO ()

Decrypt file using the specified decryptor.

Use it if setUserPassword doesn't work for you.

data NotFound

Constructors

NotFound String

Instances

Exception NotFound

Defined in Pdf.Core.File

Methods

toException :: NotFound -> SomeException

fromException :: SomeException -> Maybe NotFound

displayException :: NotFound -> String

Show NotFound

Defined in Pdf.Core.File

Methods

showsPrec :: Int -> NotFound -> ShowS

show :: NotFound -> String

showList :: [NotFound] -> ShowS