api

package
v0.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2026 License: Apache-2.0 Imports: 35 Imported by: 291

Documentation

Overview

Package api lets you integrate pdfcpu's operations into your Go backend.

There are two api layers supporting all pdfcpu operations:

  1. The file based layer (used by pdfcpu's cli)
  2. The io.ReadSeeker/io.Writer based layer for backend integration.

For any pdfcpu command there are two functions.

The file based function always calls the io.ReadSeeker/io.Writer based function: 

func CommandFile(inFile, outFile string, conf *pdf.Configuration) error
func Command(rs io.ReadSeeker, w io.Writer, conf *pdf.Configuration) error

eg. for optimization: 

func OptimizeFile(inFile, outFile string, conf *pdf.Configuration) error
func Optimize(rs io.ReadSeeker, w io.Writer, conf *pdf.Configuration) error

Index

Examples

Constants

This section is empty.

Variables

View Source 
var (
	// ErrAttachmentOutputCollision signals attachments resolving to the same output path.
	ErrAttachmentOutputCollision = errors.New("attachment output collision")

	// ErrBookletImageOutputConflict signals that booklet output aliases an image input.
	ErrBookletImageOutputConflict = errors.New("booklet image output aliases input")

	// ErrCircularBookmarks signals a circular bookmark tree.
	ErrCircularBookmarks = pdfcpu.ErrCircularBookmarks

	// ErrDuplicateCertificateDestination signals certificate inputs targeting the same installed file.
	ErrDuplicateCertificateDestination = errors.New("duplicate certificate destination")

	// ErrDuplicatePostScriptName aliases the lower-layer duplicate-name sentinel.
	ErrDuplicatePostScriptName = font.ErrDuplicatePostScriptName

	// ErrExistingBookmarks signals that adding bookmarks would conflict with existing bookmarks.
	ErrExistingBookmarks = pdfcpu.ErrExistingBookmarks

	// ErrGridImageOutputConflict signals that grid output aliases an image input.
	ErrGridImageOutputConflict = errors.New("grid image output aliases input")

	// ErrImportImagesOutputConflict signals that import-images output aliases an image input.
	ErrImportImagesOutputConflict = errors.New("import images output aliases image input")

	// ErrInvalidBookmark signals an invalid bookmark tree.
	ErrInvalidBookmark = pdfcpu.ErrInvalidBookmark

	// ErrInvalidBookmarkJSON signals malformed bookmark JSON data.
	ErrInvalidBookmarkJSON = pdfcpu.ErrInvalidBookmarkJSON

	// ErrInvalidCSV signals malformed or incomplete CSV form data.
	ErrInvalidCSV = errors.New("invalid csv input file")

	// ErrInvalidCutConfiguration signals an invalid cut configuration.
	ErrInvalidCutConfiguration = errors.New("invalid cut configuration")

	// ErrInvalidFormData signals structurally invalid decoded form data.
	ErrInvalidFormData = errors.New("invalid form data")

	// ErrInvalidImageSelection signals an invalid image object or page resource selection.
	ErrInvalidImageSelection = errors.New("invalid image selection")

	// ErrInvalidImportConfiguration signals an invalid image import configuration.
	ErrInvalidImportConfiguration = errors.New("invalid import configuration")

	// ErrInvalidJSON signals invalid JSON form data.
	ErrInvalidJSON = errors.New("invalid JSON encoding")

	// ErrInvalidPageBoundaries signals invalid page boundaries for an operation.
	ErrInvalidPageBoundaries = errors.New("invalid page boundaries")

	// ErrInvalidPageConfiguration signals an invalid page configuration.
	ErrInvalidPageConfiguration = errors.New("invalid page configuration")

	// ErrInvalidPageLayout signals an unsupported page layout.
	ErrInvalidPageLayout = errors.New("invalid page layout")

	// ErrInvalidPageMode signals an unsupported page mode.
	ErrInvalidPageMode = errors.New("invalid page mode")

	// ErrInvalidRotation signals a rotation that is not a multiple of 90 degrees.
	ErrInvalidRotation = errors.New("invalid rotation")

	// ErrInvalidResizeConfiguration signals an invalid resize configuration.
	ErrInvalidResizeConfiguration = errors.New("invalid resize configuration")

	// ErrInvalidSplitPageNumberSequence signals an invalid split page number sequence.
	ErrInvalidSplitPageNumberSequence = errors.New("invalid split page number sequence")

	// ErrInvalidSplitSpan signals an invalid split span.
	ErrInvalidSplitSpan = errors.New("invalid split span")

	// ErrInvalidUnicodePlane signals an invalid Unicode plane.
	ErrInvalidUnicodePlane = errors.New("invalid Unicode plane")

	// ErrInvalidZoomConfiguration signals an invalid zoom configuration.
	ErrInvalidZoomConfiguration = errors.New("invalid zoom configuration")

	// ErrMissingAnnotation signals a missing required annotation.
	ErrMissingAnnotation = pdfcpu.ErrMissingAnnotation

	// ErrMissingBookmarks signals that no bookmarks were provided.
	ErrMissingBookmarks = errors.New("missing bookmarks")

	// ErrMissingBookletConfiguration signals a missing booklet configuration.
	ErrMissingBookletConfiguration = errors.New("missing booklet configuration")

	// ErrMissingBoxConfiguration signals a missing box configuration.
	ErrMissingBoxConfiguration = errors.New("missing box configuration")

	// ErrMissingCertificate signals a missing required certificate.
	ErrMissingCertificate = pdfcpu.ErrMissingCertificate

	// ErrMissingCertificateInput signals a missing required certificate input file.
	ErrMissingCertificateInput = errors.New("missing certificate input")

	// ErrMissingConfiguration signals a missing pdfcpu configuration.
	ErrMissingConfiguration = errors.New("missing configuration")

	// ErrMissingCutConfiguration signals a missing cut configuration.
	ErrMissingCutConfiguration = errors.New("missing cut configuration")

	// ErrMissingDigestFunction signals a missing required digest function.
	ErrMissingDigestFunction = errors.New("missing digest function")

	// ErrMissingFontInput signals a missing required font input file.
	ErrMissingFontInput = errors.New("missing font input")

	// ErrMissingFormInput signals a missing required form input reader or file.
	ErrMissingFormInput = errors.New("missing form input")

	// ErrMissingGridConfiguration signals a missing grid configuration.
	ErrMissingGridConfiguration = errors.New("missing grid configuration")

	// ErrMissingImageInput signals a missing required image input.
	ErrMissingImageInput = errors.New("missing image input")

	// ErrMissingImageReader signals a missing required image reader.
	ErrMissingImageReader = pdfcpu.ErrMissingImageReader

	// ErrMissingJSONInput signals a missing required JSON input file.
	ErrMissingJSONInput = errors.New("missing JSON input")

	// ErrMissingJSONOutput signals a missing required JSON output file.
	ErrMissingJSONOutput = errors.New("missing JSON output")

	// ErrMissingJSONReader signals a missing required JSON input reader.
	ErrMissingJSONReader = errors.New("missing JSON reader")

	// ErrMissingJSONWriter signals a missing required JSON output writer.
	ErrMissingJSONWriter = errors.New("missing JSON writer")

	// ErrMissingNUpConfiguration signals a missing n-up configuration.
	ErrMissingNUpConfiguration = errors.New("missing n-up configuration")

	// ErrMissingPageBoundaries signals missing required page boundaries.
	ErrMissingPageBoundaries = errors.New("missing page boundaries")

	// ErrMissingPDFContext signals a missing required PDF context.
	ErrMissingPDFContext = pdfcpu.ErrMissingPDFContext

	// ErrMissingPDFInput signals a missing required PDF input file.
	ErrMissingPDFInput = errors.New("missing PDF input")

	// ErrMissingPDFOutput signals a missing required PDF output file.
	ErrMissingPDFOutput = errors.New("missing PDF output")

	// ErrMissingPDFReadSeeker signals a missing required PDF input reader.
	ErrMissingPDFReadSeeker = errors.New("missing PDF read seeker")

	// ErrMissingPDFReadWriteSeeker signals a missing required PDF input/output seeker.
	ErrMissingPDFReadWriteSeeker = errors.New("missing PDF read write seeker")

	// ErrMissingPDFWriter signals a missing required PDF output writer.
	ErrMissingPDFWriter = errors.New("missing PDF writer")

	// ErrMissingReader signals a missing required reader.
	ErrMissingReader = pdfcpu.ErrMissingReader

	// ErrMissingResizeConfiguration signals a missing resize configuration.
	ErrMissingResizeConfiguration = errors.New("missing resize configuration")

	// ErrMissingSplitPageNumbers signals missing split page numbers.
	ErrMissingSplitPageNumbers = errors.New("missing split page numbers")

	// ErrMissingWatermarkConfiguration signals a missing required watermark configuration.
	ErrMissingWatermarkConfiguration = pdfcpu.ErrMissingWatermarkConfiguration

	// ErrMissingWatermarks signals missing required watermarks.
	ErrMissingWatermarks = pdfcpu.ErrMissingWatermarks

	// ErrMissingXRefTable signals a missing required PDF cross-reference table.
	ErrMissingXRefTable = pdfcpu.ErrMissingXRefTable

	// ErrMissingZoomConfiguration signals a missing zoom configuration.
	ErrMissingZoomConfiguration = errors.New("missing zoom configuration")

	// ErrNoAttachmentAdded signals that no attachment was added.
	ErrNoAttachmentAdded = errors.New("no attachment added")

	// ErrNoAttachmentRemoved signals that no attachment was removed.
	ErrNoAttachmentRemoved = errors.New("no attachment removed")

	// ErrNoBookmarks signals that a PDF has no bookmarks to process.
	ErrNoBookmarks = pdfcpu.ErrNoBookmarks

	// ErrNoCertificates signals that a certificate file contains no usable certificates.
	ErrNoCertificates = pdfcpu.ErrNoCertificates

	// ErrNoFormData signals missing form data for a form fill operation.
	ErrNoFormData = errors.New("missing form data")

	// ErrNoFormFieldsAffected signals that a form operation did not change any fields.
	ErrNoFormFieldsAffected = errors.New("no form fields affected")

	// ErrNoKeywordRemoved signals that a remove operation did not match any keyword.
	ErrNoKeywordRemoved = errors.New("no keyword removed")

	// ErrNoOp is retained for source compatibility.
	// Deprecated: viewer-preferences reset operations are idempotent and no longer return ErrNoOp.
	ErrNoOp = errors.New("no operation")

	// ErrNoPropertyRemoved signals that a remove operation did not match any property.
	ErrNoPropertyRemoved = errors.New("no property removed")

	// ErrNoSignatures signals that a PDF has no signatures to process.
	ErrNoSignatures = pdfcpu.ErrNoSignatures

	// Deprecated: use ErrNoBookmarks.
	ErrNoOutlines = ErrNoBookmarks

	// ErrNUpImageOutputConflict signals that n-up output aliases an image input.
	ErrNUpImageOutputConflict = errors.New("n-up image output aliases input")

	// Deprecated: use ErrExistingBookmarks.
	ErrOutlines = ErrExistingBookmarks

	// ErrUnknownFont aliases the lower-layer unknown-font sentinel.
	ErrUnknownFont = font.ErrUnknownFont

	// ErrUnsupportedCertificateFile signals an unsupported certificate input file.
	ErrUnsupportedCertificateFile = pdfcpu.ErrUnsupportedCertificateFile

	// ErrUnsupportedFontFile signals an unsupported font input file.
	ErrUnsupportedFontFile = errors.New("unsupported font file")

	// ErrUnsupportedFormDataFormat signals an unsupported form data format.
	ErrUnsupportedFormDataFormat = errors.New("unsupported data format")

	// ErrUpdateImagesOutputConflict signals that update-images output aliases the image input.
	ErrUpdateImagesOutputConflict = errors.New("update images output aliases image input")

	// ErrUserFontNotFound is retained as a compatibility alias for ErrUnknownFont.
	ErrUserFontNotFound = font.ErrUnknownFont
)

Functions

func AddAnnotations added in v0.3.12 

func AddAnnotations(rs io.ReadSeeker, w io.Writer, selectedPages []string, ann model.AnnotationRenderer, conf *model.Configuration) (err error)

AddAnnotations adds annotations for selected pages in rs and writes the result to w.

func AddAnnotationsAsIncrement added in v0.3.12 

func AddAnnotationsAsIncrement(rws io.ReadWriteSeeker, selectedPages []string, ar model.AnnotationRenderer, conf *model.Configuration) (err error)

AddAnnotationsAsIncrement adds annotations for selected pages in rws and writes out a PDF increment.

func AddAnnotationsFile added in v0.3.12 

func AddAnnotationsFile(inFile, outFile string, selectedPages []string, ar model.AnnotationRenderer, conf *model.Configuration, incr bool) (err error)

AddAnnotationsFile adds annotations for selected pages to a PDF context read from inFile and writes the result to outFile.

func AddAnnotationsMap added in v0.3.12 

func AddAnnotationsMap(rs io.ReadSeeker, w io.Writer, m map[int][]model.AnnotationRenderer, conf *model.Configuration) (err error)

AddAnnotationsMap adds annotations in m to corresponding pages of rs and writes the result to w.

func AddAnnotationsMapAsIncrement added in v0.3.12 

func AddAnnotationsMapAsIncrement(rws io.ReadWriteSeeker, m map[int][]model.AnnotationRenderer, conf *model.Configuration) (err error)

AddAnnotationsMapAsIncrement adds annotations in m to corresponding pages of rws and writes out a PDF increment.

func AddAnnotationsMapFile added in v0.3.12 

func AddAnnotationsMapFile(inFile, outFile string, m map[int][]model.AnnotationRenderer, conf *model.Configuration, incr bool) (err error)

AddAnnotationsMapFile adds annotations in m to corresponding pages of inFile and writes the result to outFile.

func AddAttachments 

func AddAttachments(rs io.ReadSeeker, w io.Writer, files []string, coll bool, conf *model.Configuration) (err error)

AddAttachments embeds files into a PDF context read from rs and writes the result to w. Each file is either a file name or a file name and a description separated by a comma.

func AddAttachmentsFile added in v0.2.3 

func AddAttachmentsFile(inFile, outFile string, files []string, coll bool, conf *model.Configuration) error

AddAttachmentsFile embeds files into a PDF context read from inFile and writes the result to outFile.

Example

ExampleAddAttachmentsFile demonstrates add attachments file. 

// Attach 3 files to in.pdf.
AddAttachmentsFile("in.pdf", "", []string{"img.jpg", "attach.pdf", "test.zip"}, false, nil)

func AddBookmarks added in v0.3.12 

func AddBookmarks(rs io.ReadSeeker, w io.Writer, bms []pdfcpu.Bookmark, replace bool, conf *model.Configuration) (err error)

AddBookmarks adds bookmarks to the PDF context read from rs and writes the result to w.

func AddBookmarksFile added in v0.3.12 

func AddBookmarksFile(inFile, outFile string, bms []pdfcpu.Bookmark, replace bool, conf *model.Configuration) (err error)

AddBookmarksFile adds bookmarks to the PDF context read from inFile and writes the result to outFile.

func AddBoxes added in v0.3.8 

func AddBoxes(rs io.ReadSeeker, w io.Writer, selectedPages []string, pb *model.PageBoundaries, conf *model.Configuration) (err error)

AddBoxes adds page boundaries for selected pages of rs and writes result to w.

func AddBoxesFile added in v0.3.8 

func AddBoxesFile(inFile, outFile string, selectedPages []string, pb *model.PageBoundaries, conf *model.Configuration) (err error)

AddBoxesFile adds page boundaries for selected pages of inFile and writes result to outFile.

func AddImageWatermarksFile added in v0.3.4 

func AddImageWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *model.Configuration) error

AddImageWatermarksFile adds image stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func AddImageWatermarksForReaderFile added in v0.3.12 

func AddImageWatermarksForReaderFile(inFile, outFile string, selectedPages []string, onTop bool, r io.Reader, desc string, conf *model.Configuration) error

AddImageWatermarksForReaderFile adds image stamps/watermarks to all selected pages of inFile for r and writes the result to outFile.

func AddKeywords added in v0.3.2 

func AddKeywords(rs io.ReadSeeker, w io.Writer, keywords []string, conf *model.Configuration) (err error)

AddKeywords adds keywords to rs's infodict and writes the result to w.

func AddKeywordsFile added in v0.3.2 

func AddKeywordsFile(inFile, outFile string, keywords []string, conf *model.Configuration) error

AddKeywordsFile adds keywords to inFile's infodict and writes the result to outFile.

func AddPDFWatermarksFile added in v0.3.4 

func AddPDFWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *model.Configuration) error

AddPDFWatermarksFile adds PDF stamps/watermarks to inFile and writes the result to outFile.

func AddPDFWatermarksForReadSeekerFile added in v0.13.0 

func AddPDFWatermarksForReadSeekerFile(inFile, outFile string, selectedPages []string, onTop bool, rs io.ReadSeeker, pageNrSrc int, desc string, conf *model.Configuration) error

AddPDFWatermarksForReadSeekerFile adds PDF stamps/watermarks to inFile for rs and writes the result to outFile.

func AddProperties added in v0.3.2 

func AddProperties(rs io.ReadSeeker, w io.Writer, properties map[string]string, conf *model.Configuration) (err error)

AddProperties adds properties to rs's infodict and writes the result to w.

func AddPropertiesFile added in v0.3.2 

func AddPropertiesFile(inFile, outFile string, properties map[string]string, conf *model.Configuration) error

AddPropertiesFile adds properties to inFile's infodict and writes the result to outFile.

func AddTextWatermarksFile added in v0.3.4 

func AddTextWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, text, desc string, conf *model.Configuration) error

AddTextWatermarksFile adds text stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func AddWatermarks added in v0.1.16 

func AddWatermarks(rs io.ReadSeeker, w io.Writer, selectedPages []string, wm *model.Watermark, conf *model.Configuration) (err error)

AddWatermarks adds watermarks to all pages selected in rs and writes the result to w.

func AddWatermarksFile added in v0.2.3 

func AddWatermarksFile(inFile, outFile string, selectedPages []string, wm *model.Watermark, conf *model.Configuration) (err error)

AddWatermarksFile adds watermarks to all selected pages of inFile and writes the result to outFile.

Example

ExampleAddWatermarksFile demonstrates add watermarks file. 

// Unique abbreviations are accepted for all watermark descriptor parameters.
// eg. sc = scalefactor or rot = rotation

// Add a "Demo" watermark to all pages of in.pdf along the diagonal running from lower left to upper right.
onTop := false
update := false
wm, _ := TextWatermark("Demo", "", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Stamp all odd pages of in.pdf in red "Confidential" in 48 point Courier
// using a rotation angle of 45 degrees and an absolute scalefactor of 1.0.
onTop = true
wm, _ = TextWatermark("Confidential", "font:Courier, points:48, col: 1 0 0, rot:45, scale:1 abs, ", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", []string{"odd"}, wm, nil)

// Add image stamps to in.pdf using absolute scaling and a negative rotation of 90 degrees.
wm, _ = ImageWatermark("image.png", "scalefactor:.5 a, rot:-90", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Add a PDF stamp to all pages of in.pdf using the 2nd page of stamp.pdf, use absolute scaling of 0.5
// and rotate along the 2nd diagonal running from upper left to lower right corner.
wm, _ = PDFWatermark("stamp.pdf:2", "scale:.5 abs, diagonal:2", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

func AddWatermarksMap added in v0.3.8 

func AddWatermarksMap(rs io.ReadSeeker, w io.Writer, m map[int]*model.Watermark, conf *model.Configuration) (err error)

AddWatermarksMap adds watermarks in m to corresponding pages in rs and writes the result to w.

func AddWatermarksMapFile added in v0.3.8 

func AddWatermarksMapFile(inFile, outFile string, m map[int]*model.Watermark, conf *model.Configuration) (err error)

AddWatermarksMapFile adds watermarks to corresponding pages in m of inFile and writes the result to outFile.

func AddWatermarksSliceMap added in v0.3.10 

func AddWatermarksSliceMap(rs io.ReadSeeker, w io.Writer, m map[int][]*model.Watermark, conf *model.Configuration) (err error)

AddWatermarksSliceMap adds watermarks in m to corresponding pages in rs and writes the result to w.

func AddWatermarksSliceMapFile added in v0.3.10 

func AddWatermarksSliceMapFile(inFile, outFile string, m map[int][]*model.Watermark, conf *model.Configuration) (err error)

AddWatermarksSliceMapFile adds watermarks to corresponding pages in m of inFile and writes the result to outFile.

func Annotations added in v0.5.0 

func Annotations(rs io.ReadSeeker, selectedPages []string, conf *model.Configuration) (m map[int]model.PgAnnots, err error)

Annotations returns page annotations of rs for selected pages.

func Attachments added in v0.5.0 

func Attachments(rs io.ReadSeeker, conf *model.Configuration) (aa []model.Attachment, err error)

Attachments returns rs's attachments.

func Booklet added in v0.3.9 

func Booklet(rs io.ReadSeeker, w io.Writer, imgFiles, selectedPages []string, nup *model.NUp, conf *model.Configuration) (err error)

Booklet arranges PDF pages on larger sheets of paper and writes the result to w.

func BookletFile added in v0.3.9 

func BookletFile(inFiles []string, outFile string, selectedPages []string, nup *model.NUp, conf *model.Configuration) (err error)

BookletFile rearranges PDF pages or images into a booklet layout and writes the result to outFile.

func BookletFromImages added in v0.3.9 

func BookletFromImages(conf *model.Configuration, imageFileNames []string, nup *model.NUp) (ctx *model.Context, err error)

BookletFromImages creates a booklet from images.

func Bookmarks added in v0.5.0 

func Bookmarks(rs io.ReadSeeker, conf *model.Configuration) (bms []pdfcpu.Bookmark, err error)

Bookmarks returns rs's bookmark hierarchy.

func Box added in v0.3.8 

func Box(s string, u types.DisplayUnit) (*model.Box, error)

Box parses a box definition.

func Boxes added in v0.5.0 

func Boxes(rs io.ReadSeeker, selectedPages []string, conf *model.Configuration) (pb []model.PageBoundaries, err error)

Boxes returns rs's page boundaries for selected pages of rs.

func ChangeOwnerPassword 

func ChangeOwnerPassword(rs io.ReadSeeker, w io.Writer, pwOld, pwNew string, conf *model.Configuration) (err error)

ChangeOwnerPassword reads a PDF stream from rs, changes the owner password and writes the encrypted PDF stream to w. A configuration containing the current passwords is required.

func ChangeOwnerPasswordFile added in v0.2.3 

func ChangeOwnerPasswordFile(inFile, outFile string, pwOld, pwNew string, conf *model.Configuration) error

ChangeOwnerPasswordFile reads inFile, changes the owner password and writes the result to outFile. A configuration containing the current passwords is required.

Example

ExampleChangeOwnerPasswordFile demonstrates change owner password file. 

// Changing the owner password for an AES-256 encrypted file.
conf := model.NewAESConfiguration("upw", "opw", 256)
ChangeOwnerPasswordFile("in.pdf", "", "opw", "opwNew", conf)

func ChangeUserPassword 

func ChangeUserPassword(rs io.ReadSeeker, w io.Writer, pwOld, pwNew string, conf *model.Configuration) (err error)

ChangeUserPassword reads a PDF stream from rs, changes the user password and writes the encrypted PDF stream to w. A configuration containing the current passwords is required.

func ChangeUserPasswordFile added in v0.2.3 

func ChangeUserPasswordFile(inFile, outFile string, pwOld, pwNew string, conf *model.Configuration) error

ChangeUserPasswordFile reads inFile, changes the user password and writes the result to outFile. A configuration containing the current passwords is required.

Example

ExampleChangeUserPasswordFile demonstrates change user password file. 

// Changing the user password for an AES-256 encrypted file.
conf := model.NewAESConfiguration("upw", "opw", 256)
ChangeUserPasswordFile("in.pdf", "", "upw", "upwNew", conf)

func Collect added in v0.3.2 

func Collect(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *model.Configuration) (err error)

Collect creates a custom PDF page sequence for selected pages of rs and writes the result to w.

func CollectFile added in v0.3.2 

func CollectFile(inFile, outFile string, selectedPages []string, conf *model.Configuration) (err error)

CollectFile creates a custom PDF page sequence for inFile and writes the result to outFile.

func Create added in v0.4.0 

func Create(rs io.ReadSeeker, rd io.Reader, w io.Writer, conf *model.Configuration) (err error)

Create renders the PDF structure represented by rs into w. If rs is present, new PDF content will be appended including any empty pages needed. rd is a JSON representation of PDF page content which may include form data.

func CreateCheatSheetsUserFonts added in v0.3.7 

func CreateCheatSheetsUserFonts(fontNames []string) (err error)

CreateCheatSheetsUserFonts atomically generates a batch of user-font cheat sheets. Every PDF is written to same-directory staging before publication. Generation failure leaves existing outputs untouched; publication failure attempts a full rollback and joins rollback diagnostics. Cleanup failure after completed publication is returned as an error and does not retract published PDFs.

func CreateFile added in v0.4.0 

func CreateFile(inFilePDF, inFileJSON, outFilePDF string, conf *model.Configuration) (err error)

CreateFile renders the PDF structure represented by inFileJSON into outFilePDF. If inFilePDF is present, new PDF content will be appended including any empty pages needed. inFileJSON represents PDF page content which may include form data.

func CreatePDFFile added in v0.2.3 

func CreatePDFFile(xRefTable *model.XRefTable, outFile string, conf *model.Configuration) error

CreatePDFFile creates a PDF file for an xRefTable and writes it to outFile.

func CreateUserFontDemoFiles added in v0.3.7 

func CreateUserFontDemoFiles(dir, fn string) (err error)

CreateUserFontDemoFiles atomically generates and publishes one PDF for each covered Unicode plane. Generation failure leaves all existing output files untouched. Publication failure attempts to restore every replaced file and joins any rollback failure.

func Crop added in v0.3.8 

func Crop(rs io.ReadSeeker, w io.Writer, selectedPages []string, b *model.Box, conf *model.Configuration) (err error)

Crop adds crop boxes for selected pages of rs and writes result to w.

func CropFile added in v0.3.8 

func CropFile(inFile, outFile string, selectedPages []string, b *model.Box, conf *model.Configuration) (err error)

CropFile adds crop boxes for selected pages of inFile and writes result to outFile.

func Cut added in v0.4.1 

func Cut(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, cut *model.Cut, conf *model.Configuration) (err error)

Cut applies cutConf for selected pages of rs and writes results to outDir. Each generated output is written atomically. Outputs completed for earlier pages remain if a later page fails.

func CutFile added in v0.4.1 

func CutFile(inFile, outDir, outFile string, selectedPages []string, cut *model.Cut, conf *model.Configuration) (err error)

CutFile applies cutConf for selected pages of inFile and writes results to outDir. Each generated output is written atomically. Outputs completed for earlier pages remain if a later page fails.

func Decrypt 

func Decrypt(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

Decrypt reads an encrypted PDF stream from rs and writes the decrypted PDF stream to w. A configuration containing at least the current passwords is required.

func DecryptFile added in v0.2.3 

func DecryptFile(inFile, outFile string, conf *model.Configuration) error

DecryptFile decrypts inFile and writes the result to outFile. A configuration containing at least the current passwords is required.

Example

ExampleDecryptFile demonstrates decrypt file. 

// Decrypting an AES-256 encrypted file.
conf := model.NewAESConfiguration("upw", "opw", 256)
DecryptFile("in.pdf", "", conf)

func DefaultBookletConfig added in v0.14.0 

func DefaultBookletConfig() *model.NUp

DefaultBookletConfig returns the default configuration for a booklet.

func DefaultImportConfig added in v0.14.0 

func DefaultImportConfig() *pdfcpu.Import

DefaultImportConfig returns the default image import configuration.

func DisableConfigDir added in v0.3.6 

func DisableConfigDir()

DisableConfigDir disables the configuration directory. Any needed default configuration will be loaded from configuration.go Since the config dir also contains the user font dir, this also limits font usage to the default core font set No user fonts will be available.

func Encrypt 

func Encrypt(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

Encrypt reads a PDF stream from rs and writes the encrypted PDF stream to w. A configuration containing at least the current passwords is required.

func EncryptFile added in v0.2.3 

func EncryptFile(inFile, outFile string, conf *model.Configuration) error

EncryptFile encrypts inFile and writes the result to outFile. A configuration containing at least the current passwords is required.

Example

ExampleEncryptFile demonstrates encrypt file. 

// Encrypting a file using AES-256.
conf := model.NewAESConfiguration("upw", "opw", 256)
EncryptFile("in.pdf", "", conf)

func EnsureDefaultConfigAt added in v0.3.6 

func EnsureDefaultConfigAt(path string) error

EnsureDefaultConfigAt switches to the pdfcpu config dir located at path. If path/pdfcpu is not existent, it will be created including config.yml

func ExportBookmarksFile added in v0.5.0 

func ExportBookmarksFile(inFilePDF, outFileJSON string, conf *model.Configuration) (err error)

ExportBookmarksFile extracts bookmark data from inFilePDF and writes the result to outFileJSON.

func ExportBookmarksJSON added in v0.5.0 

func ExportBookmarksJSON(rs io.ReadSeeker, w io.Writer, source string, conf *model.Configuration) (err error)

ExportBookmarksJSON extracts bookmark data from rs (originating from source) and writes the result to w.

func ExportForm added in v0.4.0 

func ExportForm(rs io.ReadSeeker, source string, conf *model.Configuration) (formGroup *form.FormGroup, err error)

ExportForm extracts form data originating from source from rs.

func ExportFormFile added in v0.4.0 

func ExportFormFile(inFilePDF, outFileJSON string, conf *model.Configuration) (err error)

ExportFormFile extracts form data from inFilePDF and writes the result to outFileJSON.

func ExportFormJSON added in v0.5.0 

func ExportFormJSON(rs io.ReadSeeker, w io.Writer, source string, conf *model.Configuration) (err error)

ExportFormJSON extracts form data originating from source from rs and writes the result to w.

func ExtractAttachments 

func ExtractAttachments(rs io.ReadSeeker, outDir string, fileNames []string, conf *model.Configuration) (err error)

ExtractAttachments extracts embedded files from a PDF context read from rs into outDir.

func ExtractAttachmentsFile added in v0.2.3 

func ExtractAttachmentsFile(inFile, outDir string, files []string, conf *model.Configuration) (err error)

ExtractAttachmentsFile extracts embedded files from a PDF context read from inFile into outDir.

Example

ExampleExtractAttachmentsFile demonstrates extract attachments file. 

// Extract 1 attachment from in.pdf into outDir.
ExtractAttachmentsFile("in.pdf", "outDir", []string{"img.jpg"}, nil)

// Extract all attachments from in.pdf into outDir
ExtractAttachmentsFile("in.pdf", "outDir", nil, nil)

func ExtractAttachmentsRaw added in v0.3.12 

func ExtractAttachmentsRaw(rs io.ReadSeeker, outDir string, fileNames []string, conf *model.Configuration) (aa []model.Attachment, err error)

ExtractAttachmentsRaw extracts embedded files from a PDF context read from rs. outDir is retained for API compatibility and is otherwise ignored.

func ExtractContent 

func ExtractContent(rs io.ReadSeeker, selectedPages []string, digestContent func(io.Reader, int) error, conf *model.Configuration) (err error)

ExtractContent retrieves and digests PDF sources from rs for selected pages.

func ExtractContentFile added in v0.2.3 

func ExtractContentFile(inFile, outDir string, selectedPages []string, conf *model.Configuration) (err error)

ExtractContentFile dumps "PDF source" files from inFile into outDir for selected pages.

Example

ExampleExtractContentFile demonstrates extract content file. 

// Extract content for all pages in PDF syntax from in.pdf into outDir.
ExtractContentFile("in.pdf", "outDir", nil, nil)

func ExtractFonts 

func ExtractFonts(rs io.ReadSeeker, selectedPages []string, digestFont func(pdfcpu.Font) error, conf *model.Configuration) (err error)

ExtractFonts retrieves and digests embedded fontfiles from rs for selected pages. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError after all supported fonts have been digested.

func ExtractFontsFile added in v0.2.3 

func ExtractFontsFile(inFile, outDir string, selectedPages []string, conf *model.Configuration) (err error)

ExtractFontsFile writes embedded fontfiles from inFile into outDir for selected pages. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError after all supported fonts have been written.

Example

ExampleExtractFontsFile demonstrates extract fonts file. 

// Extract embedded fonts for pages 1-3 from in.pdf into outDir.
ExtractFontsFile("in.pdf", "outDir", []string{"1-3"}, nil)

func ExtractImages 

func ExtractImages(rs io.ReadSeeker, selectedPages []string, digestImage func(model.Image, bool, int) error, conf *model.Configuration) (err error)

ExtractImages extracts and digests embedded image resources from rs for selected pages. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError after all supported images have been digested.

func ExtractImagesFile added in v0.2.3 

func ExtractImagesFile(inFile, outDir string, selectedPages []string, conf *model.Configuration) (err error)

ExtractImagesFile dumps embedded image resources from inFile into outDir for selected pages. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError after all supported images have been written.

Example

ExampleExtractImagesFile demonstrates extract images file. 

// Extract embedded images from in.pdf into outDir.
ExtractImagesFile("in.pdf", "outDir", nil, nil)

func ExtractImagesRaw added in v0.3.12 

func ExtractImagesRaw(rs io.ReadSeeker, selectedPages []string, conf *model.Configuration) (images []map[int]model.Image, err error)

ExtractImagesRaw returns image maps containing readers for images on selectedPages. Note: may be memory intensive. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError and images contains all successfully extracted images.

func ExtractMetadata added in v0.1.16 

func ExtractMetadata(rs io.ReadSeeker, digestMetadata func(pdfcpu.Metadata) error, conf *model.Configuration) (err error)

ExtractMetadata retrieves and digests all metadata dict entries for rs. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError after all supported metadata has been digested.

func ExtractMetadataFile added in v0.2.3 

func ExtractMetadataFile(inFile, outDir string, conf *model.Configuration) (err error)

ExtractMetadataFile dumps all metadata dict entries for inFile into outDir. Unsupported resources are handled according to conf.UnsupportedResourcePolicy. In skip mode err contains an *UnsupportedResourceError after all supported metadata has been written.

Example

ExampleExtractMetadataFile demonstrates extract metadata file. 

// Extract all metadata from in.pdf into outDir.
ExtractMetadataFile("in.pdf", "outDir", nil)

func ExtractPage added in v0.8.0 

func ExtractPage(ctx *model.Context, pageNr int) (io.Reader, error)

ExtractPage extracts the page with pageNr out of ctx into an io.Reader.

func ExtractPages 

func ExtractPages(rs io.ReadSeeker, selectedPages []string, digestPage func(io.Reader, int) error, conf *model.Configuration) (err error)

ExtractPages retrieves and digests single page PDF files from rs for selected pages.

func ExtractPagesFile added in v0.2.3 

func ExtractPagesFile(inFile, outDir string, selectedPages []string, conf *model.Configuration) (err error)

ExtractPagesFile generates single page PDF files from inFile in outDir for selected pages.

Example

ExampleExtractPagesFile demonstrates extract pages file. 

// Extract all even numbered pages from in.pdf into outDir.
ExtractPagesFile("in.pdf", "outDir", []string{"even"}, nil)

func FillForm added in v0.4.0 

func FillForm(rs io.ReadSeeker, rd io.Reader, w io.Writer, conf *model.Configuration) (err error)

FillForm populates the form rs with data from rd and writes the result to w.

func FillFormFile added in v0.4.0 

func FillFormFile(inFilePDF, inFileJSON, outFilePDF string, conf *model.Configuration) (err error)

FillFormFile populates the form inFilePDF with data from inFileJSON and writes the result to outFilePDF.

func FormFields added in v0.5.0 

func FormFields(rs io.ReadSeeker, conf *model.Configuration) (fields []form.Field, err error)

FormFields returns all form fields of rs.

func GetPermissions added in v0.3.4 

func GetPermissions(rs io.ReadSeeker, conf *model.Configuration) (p *int16, err error)

GetPermissions returns the permissions for rs.

func GetPermissionsFile added in v0.3.4 

func GetPermissionsFile(inFile string, conf *model.Configuration) (p *int16, err error)

GetPermissionsFile returns the permissions for inFile.

func Grid added in v0.14.0 

func Grid(rs io.ReadSeeker, w io.Writer, imgFiles, selectedPages []string, nup *model.NUp, conf *model.Configuration) (err error)

Grid rearranges PDF pages or images into page grids and writes the result to w. Either rs or imgFiles will be used.

func GridFile added in v0.14.0 

func GridFile(inFiles []string, outFile string, selectedPages []string, nup *model.NUp, conf *model.Configuration) (err error)

GridFile rearranges PDF pages or images into page grids and writes the result to outFile.

func GridFromImage added in v0.14.0 

func GridFromImage(conf *model.Configuration, imageFileNames []string, nup *model.NUp) (ctx *model.Context, err error)

GridFromImage creates a page grid context for one or more images. On error, the returned context may be partially constructed and its PageCount remains at the pre-operation value. Callers must discard a non-nil context returned together with an error.

func HasWatermarks added in v0.3.1 

func HasWatermarks(rs io.ReadSeeker, conf *model.Configuration) (ok bool, err error)

HasWatermarks checks rs for watermarks.

func HasWatermarksFile added in v0.3.1 

func HasWatermarksFile(inFile string, conf *model.Configuration) (ok bool, err error)

HasWatermarksFile checks inFile for watermarks.

func ImageBookletConfig added in v0.3.9 

func ImageBookletConfig(val int, desc string, conf *model.Configuration) (*model.NUp, error)

ImageBookletConfig returns an NUp configuration for Booklet-ing image files.

func ImageGridConfig added in v0.3.9 

func ImageGridConfig(rows, cols int, desc string, conf *model.Configuration) (*model.NUp, error)

ImageGridConfig returns a grid configuration for image files.

func ImageNUpConfig added in v0.3.9 

func ImageNUpConfig(val int, desc string, conf *model.Configuration) (*model.NUp, error)

ImageNUpConfig returns an NUp configuration for Nup-ing image files.

func ImageWatermark added in v0.3.4 

func ImageWatermark(fileName, desc string, onTop, update bool, u types.DisplayUnit) (*model.Watermark, error)

ImageWatermark returns an image watermark configuration.

func ImageWatermarkForReader added in v0.3.12 

func ImageWatermarkForReader(rd io.Reader, desc string, onTop, update bool, u types.DisplayUnit) (*model.Watermark, error)

ImageWatermarkForReader returns an image watermark configuration for r.

func Images added in v0.5.0 

func Images(rs io.ReadSeeker, selectedPages []string, conf *model.Configuration) (ii []map[int]model.Image, err error)

Images returns all embedded images of rs.

func Import added in v0.3.8 

func Import(s string, u types.DisplayUnit) (*pdfcpu.Import, error)

Import parses an Import command string into an internal structure.

func ImportBookmarks added in v0.5.0 

func ImportBookmarks(rs io.ReadSeeker, rd io.Reader, w io.Writer, replace bool, conf *model.Configuration) (err error)

ImportBookmarks creates/replaces bookmarks in rs and writes the result to w.

func ImportBookmarksFile added in v0.5.0 

func ImportBookmarksFile(inFilePDF, inFileJSON, outFilePDF string, replace bool, conf *model.Configuration) (err error)

ImportBookmarksFile creates/replaces bookmarks in inFilePDF and writes the result to outFilePDF.

func ImportCertificates added in v0.10.0 

func ImportCertificates(inFiles []string) (ss []string, err error)

ImportCertificates validates and installs certificate files into the pdfcpu configuration directory. Existing destinations with the same derived name are replaced transactionally.

func ImportImages added in v0.1.20 

func ImportImages(rs io.ReadSeeker, w io.Writer, imgs []io.Reader, imp *pdfcpu.Import, conf *model.Configuration) (err error)

ImportImages appends PDF pages containing images to rs and writes the result to w. If rs == nil a new PDF file will be written to w.

func ImportImagesFile added in v0.2.3 

func ImportImagesFile(imgFiles []string, outFile string, imp *pdfcpu.Import, conf *model.Configuration) (err error)

ImportImagesFile appends PDF pages containing images to outFile which will be created if necessary.

Example

ExampleImportImagesFile demonstrates import images file. 

// Convert an image into a single page of out.pdf which will be created if necessary.
// The page dimensions will match the image dimensions.
// If out.pdf already exists, append a new page.
// Use the default import configuration.
ImportImagesFile([]string{"image.png"}, "out.pdf", nil, nil)

// Import images by creating an A3 page for each image.
// Images are page centered with 1.0 relative scaling.
// Import an image as a new page of the existing out.pdf.
imp, _ := Import("form:A3, pos:c, s:1.0", types.POINTS)
ImportImagesFile([]string{"a1.png", "a2.jpg", "a3.tiff"}, "out.pdf", imp, nil)

func InsertPages added in v0.2.3 

func InsertPages(rs io.ReadSeeker, w io.Writer, selectedPages []string, before bool, pageConf *pdfcpu.PageConfiguration, conf *model.Configuration) (err error)

InsertPages inserts a blank page before or after every page selected of rs and writes the result to w.

func InsertPagesFile added in v0.2.3 

func InsertPagesFile(inFile, outFile string, selectedPages []string, before bool, pageConf *pdfcpu.PageConfiguration, conf *model.Configuration) (err error)

InsertPagesFile inserts a blank page before or after every selected inFile page and writes the result to outFile.

Example

ExampleInsertPagesFile demonstrates insert pages file. 

// Insert a blank page into in.pdf before page #3.
InsertPagesFile("in.pdf", "", []string{"3"}, true, nil, nil)

// Insert a blank page into in.pdf after every page.
InsertPagesFile("in.pdf", "", nil, false, nil, nil)

func InspectCertificates added in v0.11.0 

func InspectCertificates(inFiles []string) (ss []string, err error)

InspectCertificates loads and inspects certificates from inFiles.

func InstallFonts added in v0.3.1 

func InstallFonts(fileNames []string) error

InstallFonts transactionally installs true type fonts for embedding. The batch uses directory staging, backup, commit, and rollback rather than the single-file stagedOutput publication contract. An empty file list reloads already installed user fonts without modifying the font directory.

func Keywords added in v0.5.0 

func Keywords(rs io.ReadSeeker, conf *model.Configuration) (ss []string, err error)

Keywords returns the keywords of rs's info dict.

func ListBookmarks added in v0.14.0 

func ListBookmarks(rs io.ReadSeeker, conf *model.Configuration) (ss []string, err error)

ListBookmarks returns a formatted list of rs's bookmarks.

func ListBookmarksFile added in v0.14.0 

func ListBookmarksFile(inFile string, conf *model.Configuration) (ss []string, err error)

ListBookmarksFile returns a formatted list of inFile's bookmarks.

func ListBoxes added in v0.3.8 

func ListBoxes(rs io.ReadSeeker, selectedPages []string, pb *model.PageBoundaries, conf *model.Configuration) (ss []string, err error)

ListBoxes returns formatted page boundaries for selected pages of rs.

func ListBoxesFile added in v0.3.8 

func ListBoxesFile(inFile string, selectedPages []string, pb *model.PageBoundaries, conf *model.Configuration) (ss []string, err error)

ListBoxesFile returns formatted page boundaries for selected pages of inFile.

func ListCertificates added in v0.14.0 

func ListCertificates(json bool) (ss []string, err error)

ListCertificates returns installed certificates.

func ListFonts added in v0.3.1 

func ListFonts() ([]string, error)

ListFonts returns a list of supported fonts.

func ListFormFields added in v0.4.0 

func ListFormFields(rs io.ReadSeeker, conf *model.Configuration) (fields []string, err error)

ListFormFields returns a rendered list of all form fields in rs.

func ListImages added in v0.3.12 

func ListImages(rs io.ReadSeeker, selectedPages []string, conf *model.Configuration) (ss []string, err error)

ListImages returns a formatted list of all embedded images of rs.

func ListPageLayout added in v0.6.0 

func ListPageLayout(rs io.ReadSeeker, conf *model.Configuration) (ss []string, err error)

ListPageLayout lists rs's page layout.

func ListPageLayoutFile added in v0.6.0 

func ListPageLayoutFile(inFile string, conf *model.Configuration) (ss []string, err error)

ListPageLayoutFile lists inFile's page layout.

func ListPageMode added in v0.6.0 

func ListPageMode(rs io.ReadSeeker, conf *model.Configuration) (ss []string, err error)

ListPageMode lists rs's page mode.

func ListPageModeFile added in v0.6.0 

func ListPageModeFile(inFile string, conf *model.Configuration) (ss []string, err error)

ListPageModeFile lists inFile's page mode.

func ListViewerPreferences added in v0.6.0 

func ListViewerPreferences(rs io.ReadSeeker, all bool, conf *model.Configuration) (ss []string, err error)

ListViewerPreferences returns rs's viewer preferences.

func ListViewerPreferencesFile added in v0.6.0 

func ListViewerPreferencesFile(inFile string, all, json bool, conf *model.Configuration) (ss []string, err error)

ListViewerPreferencesFile lists inFile's viewer preferences.

func ListViewerPreferencesFileJSON added in v0.6.0 

func ListViewerPreferencesFileJSON(inFile string, all bool, conf *model.Configuration) (ss []string, err error)

ListViewerPreferencesFileJSON lists inFile's viewer preferences in JSON.

func ListViewerPreferencesJSON added in v0.14.0 

func ListViewerPreferencesJSON(rs io.ReadSeeker, all bool, conf *model.Configuration) ([]string, error)

ListViewerPreferencesJSON returns rs's viewer preferences in JSON.

func LoadConfiguration added in v0.3.7 

func LoadConfiguration() *model.Configuration

LoadConfiguration locates and loads the default configuration and also loads installed user fonts.

func LockFormFields added in v0.4.0 

func LockFormFields(rs io.ReadSeeker, w io.Writer, fieldIDsOrNames []string, conf *model.Configuration) (err error)

LockFormFields turns form fields in rs into read-only and writes the result to w.

func LockFormFieldsFile added in v0.4.0 

func LockFormFieldsFile(inFile, outFile string, fieldIDsOrNames []string, conf *model.Configuration) (err error)

LockFormFieldsFile turns form fields of inFile into read-only and writes the result to outFile.

func Merge 

func Merge(destFile string, inFiles []string, w io.Writer, conf *model.Configuration, dividerPage bool) (err error)

Merge concatenates inFiles. if destFile is supplied it appends the result to destfile (=MERGEAPPEND) if no destFile supplied it writes the result to the first entry of inFiles (=MERGECREATE).

func MergeAppendFile added in v0.3.3 

func MergeAppendFile(inFiles []string, outFile string, dividerPage bool, conf *model.Configuration) (err error)

MergeAppendFile appends inFiles to outFile.

Example

ExampleMergeAppendFile demonstrates merge append file. 

// Merge inFiles by concatenation in the order specified and write the result to out.pdf.
// If out.pdf already exists it will be preserved and serves as the beginning of the merge result.
inFiles := []string{"in1.pdf", "in2.pdf"}
MergeAppendFile(inFiles, "out.pdf", false, nil)

func MergeCreateFile added in v0.3.3 

func MergeCreateFile(inFiles []string, outFile string, dividerPage bool, conf *model.Configuration) (err error)

MergeCreateFile merges inFiles and writes the result to outFile.

Example

ExampleMergeCreateFile demonstrates merge create file. 

// Merge inFiles by concatenation in the order specified and write the result to out.pdf.
// out.pdf will be overwritten.
inFiles := []string{"in1.pdf", "in2.pdf"}
MergeCreateFile(inFiles, "out.pdf", false, nil)

func MergeCreateZip added in v0.6.0 

func MergeCreateZip(rs1, rs2 io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

MergeCreateZip zips rs1 and rs2 into w.

func MergeCreateZipFile added in v0.6.0 

func MergeCreateZipFile(inFile1, inFile2, outFile string, conf *model.Configuration) (err error)

MergeCreateZipFile zips inFile1 and inFile2 into outFile.

func MergeRaw added in v0.4.1 

func MergeRaw(rsc []io.ReadSeeker, w io.Writer, dividerPage bool, conf *model.Configuration) (err error)

MergeRaw merges a sequence of PDF streams and writes the result to w.

func MultiFillForm added in v0.4.0 

func MultiFillForm(inFilePDF string, rd io.Reader, outDir, fileName string, format form.DataFormat, merge bool, conf *model.Configuration) error

MultiFillForm populates multiple instances of inFilePDF's form with data from rd and writes the result to outDir.

func MultiFillFormFile added in v0.4.0 

func MultiFillFormFile(inFilePDF, inFileData, outDir, outFilePDF string, merge bool, conf *model.Configuration) (err error)

MultiFillFormFile populates multiple instances of inFilePDF's form with data from inFileData and writes the result to outDir. The output file will be written to outFilePDF with incrementing numerical suffix unless the input JSON uses "filename" or the input CSV contains a @filename field.

func NDown added in v0.4.1 

func NDown(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, n int, cut *model.Cut, conf *model.Configuration) (err error)

NDown applies n & cutConf for selected pages of rs and writes results to outDir. Each generated output is written atomically. Outputs completed for earlier pages remain if a later page fails.

func NDownFile added in v0.4.1 

func NDownFile(inFile, outDir, outFile string, selectedPages []string, n int, cut *model.Cut, conf *model.Configuration) (err error)

NDownFile applies n & cutConf for selected pages of inFile and writes results to outDir. Each generated output is written atomically. Outputs completed for earlier pages remain if a later page fails.

func NUp added in v0.1.21 

func NUp(rs io.ReadSeeker, w io.Writer, imgFiles, selectedPages []string, nup *model.NUp, conf *model.Configuration) (err error)

NUp rearranges PDF pages or images into page grids and writes the result to w. Either rs or imgFiles will be used.

func NUpFile added in v0.2.3 

func NUpFile(inFiles []string, outFile string, selectedPages []string, nup *model.NUp, conf *model.Configuration) (err error)

NUpFile rearranges PDF pages or images into page grids and writes the result to outFile.

Example

ExampleNUpFile demonstrates n up file. 

// 4-Up in.pdf and write result to out.pdf.
nup, _ := PDFNUpConfig(4, "", nil)
inFiles := []string{"in.pdf"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

// 9-Up a sequence of images using format Tabloid w/o borders and no margins.
nup, _ = ImageNUpConfig(9, "f:Tabloid, b:off, margin:0", nil)
inFiles = []string{"in1.png", "in2.jpg", "in3.tiff"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

// TestGridFromPDF
nup, _ = PDFGridConfig(1, 3, "f:LegalL", nil)
inFiles = []string{"in.pdf"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

// TestGridFromImages
nup, _ = ImageGridConfig(4, 2, "d:500 500, m:20, b:off", nil)
inFiles = []string{"in1.png", "in2.jpg", "in3.tiff"}
NUpFile(inFiles, "out.pdf", nil, nup, nil)

func NUpFromImage added in v0.3.8 

func NUpFromImage(conf *model.Configuration, imageFileNames []string, nup *model.NUp) (ctx *model.Context, err error)

NUpFromImage creates a single page n-up PDF for one image or a sequence of n-up pages for more than one image. On error, the returned context may be partially constructed and its PageCount remains at the pre-operation value. Callers must discard a non-nil context returned together with an error.

func NUpValues added in v0.14.0 

func NUpValues() []int

NUpValues returns the supported n-up page counts per sheet.

func NUpValuesForBooklets added in v0.14.0 

func NUpValuesForBooklets() []int

NUpValuesForBooklets returns the supported booklet page counts per sheet.

func Optimize 

func Optimize(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

Optimize reads a PDF stream from rs and writes the optimized PDF stream to w. noEncryption ensures w writes without encryption.

func OptimizeContext added in v0.1.18 

func OptimizeContext(ctx *model.Context) error

OptimizeContext optimizes ctx.

func OptimizeFile added in v0.2.3 

func OptimizeFile(inFile, outFile string, conf *model.Configuration) (err error)

OptimizeFile reads inFile and writes the optimized PDF to outFile. If outFile is not provided then inFile gets overwritten which leads to the same result as when inFile equals outFile. noEncryption ensures outFile is not encrypted.

Example

ExampleOptimizeFile demonstrates optimize file. 

conf := model.NewDefaultConfiguration()

// Set passwords for encrypted files.
conf.UserPW = "upw"
conf.OwnerPW = "opw"

// Configure end of line sequence for writing.
conf.Eol = types.EolLF

// Create an optimized version of in.pdf and write it to out.pdf.
OptimizeFile("in.pdf", "out.pdf", conf)

// Create an optimized version of inFile.
// If you want to modify the original file, pass an empty string for outFile.
// Use nil for a default configuration.
OptimizeFile("in.pdf", "", nil)

func PDFBookletConfig added in v0.3.9 

func PDFBookletConfig(val int, desc string, conf *model.Configuration) (*model.NUp, error)

PDFBookletConfig returns an NUp configuration for Booklet-ing PDF files.

func PDFGridConfig added in v0.3.9 

func PDFGridConfig(rows, cols int, desc string, conf *model.Configuration) (*model.NUp, error)

PDFGridConfig returns a grid configuration for PDF files.

func PDFInfo added in v0.5.0 

func PDFInfo(rs io.ReadSeeker, fileName string, selectedPages []string, fonts bool, conf *model.Configuration) (info *pdfcpu.PDFInfo, err error)

PDFInfo returns information about rs.

func PDFMultiWatermarkForReadSeeker added in v0.6.0 

func PDFMultiWatermarkForReadSeeker(rs io.ReadSeeker, startPageNrSrc, startPageNrDest int, desc string, onTop, update bool, u types.DisplayUnit) (*model.Watermark, error)

PDFMultiWatermarkForReadSeeker returns a PDF watermark configuration. Define a source PDF watermark/stamp sequence using rs from page startPageNrSrc thru the last page of rs. Apply this sequence to the destination PDF file starting at page startPageNrDest for selected pages.

func PDFNUpConfig added in v0.3.9 

func PDFNUpConfig(val int, desc string, conf *model.Configuration) (*model.NUp, error)

PDFNUpConfig returns an NUp configuration for Nup-ing PDF files.

func PDFWatermark added in v0.3.4 

func PDFWatermark(fileName, desc string, onTop, update bool, u types.DisplayUnit) (*model.Watermark, error)

PDFWatermark returns a PDF watermark configuration.

func PDFWatermarkForReadSeeker added in v0.6.0 

func PDFWatermarkForReadSeeker(rs io.ReadSeeker, pageNrSrc int, desc string, onTop, update bool, u types.DisplayUnit) (*model.Watermark, error)

PDFWatermarkForReadSeeker returns a PDF watermark configuration. Apply watermark/stamp to destination file with pageNrSrc of rs for selected pages. If pageNr == 0 apply a multi watermark/stamp applying all src pages in ascending manner to destination pages.

func PageBoundaries added in v0.3.8 

func PageBoundaries(s string, unit types.DisplayUnit) (*model.PageBoundaries, error)

PageBoundaries parses a list of box definitions and assignments.

func PageBoundariesFromBoxList added in v0.3.8 

func PageBoundariesFromBoxList(s string) (*model.PageBoundaries, error)

PageBoundariesFromBoxList parses a list of box types.

func PageCount added in v0.2.3 

func PageCount(rs io.ReadSeeker, conf *model.Configuration) (count int, err error)

PageCount returns rs's page count.

func PageCountFile added in v0.3.1 

func PageCountFile(inFile string) (count int, err error)

PageCountFile returns inFile's page count.

func PageDims added in v0.2.4 

func PageDims(rs io.ReadSeeker, conf *model.Configuration) (pd []types.Dim, err error)

PageDims returns media box dimensions for rs in ascending page order.

func PageDimsFile added in v0.2.5 

func PageDimsFile(inFile string) (pd []types.Dim, err error)

PageDimsFile returns media box dimensions for inFile in ascending page order.

func PageLayout added in v0.6.0 

func PageLayout(rs io.ReadSeeker, conf *model.Configuration) (pl *model.PageLayout, err error)

PageLayout returns rs's page layout.

func PageLayoutFile added in v0.6.0 

func PageLayoutFile(inFile string, conf *model.Configuration) (pl *model.PageLayout, err error)

PageLayoutFile returns inFile's page layout.

func PageMode added in v0.6.0 

func PageMode(rs io.ReadSeeker, conf *model.Configuration) (pm *model.PageMode, err error)

PageMode returns rs's page mode.

func PageModeFile added in v0.6.0 

func PageModeFile(inFile string, conf *model.Configuration) (pm *model.PageMode, err error)

PageModeFile returns inFile's page mode.

func PagesForPageCollection added in v0.3.2 

func PagesForPageCollection(pageCount int, pageSelection []string) ([]int, error)

PagesForPageCollection returns a slice of page numbers for a page collection. Any page number in any order any number of times allowed.

func PagesForPageRange added in v0.3.6 

func PagesForPageRange(from, thru int) []int

PagesForPageRange returns a slice of page numbers for a valid page range. It returns nil for non-positive or descending ranges.

func PagesForPageSelection added in v0.3.2 

func PagesForPageSelection(pageCount int, pageSelection []string, ensureAllforNone bool, log bool) (types.IntSet, error)

PagesForPageSelection ensures a set of page numbers for an ascending page sequence where each page number may appear only once.

func ParseGridDefinition added in v0.14.0 

func ParseGridDefinition(rows, cols int, nup *model.NUp) error

ParseGridDefinition applies grid dimensions to a grid configuration.

func ParseNUpDetails added in v0.14.0 

func ParseNUpDetails(s string, nup *model.NUp) error

ParseNUpDetails parses an n-up command string into nup.

func ParseNUpGridDefinition deprecated added in v0.14.0 

func ParseNUpGridDefinition(rows, cols int, nup *model.NUp) error

ParseNUpGridDefinition applies grid dimensions to a shared imposition configuration.

Deprecated: use ParseGridDefinition for grid command handling.

func ParseNUpValue added in v0.14.0 

func ParseNUpValue(n int, nup *model.NUp) error

ParseNUpValue applies an n-up page count to nup.

func ParsePageSelection 

func ParsePageSelection(s string) ([]string, error)

ParsePageSelection ensures a correct page selection expression.

func PatchFile added in v0.12.0 

func PatchFile(fileName string, bb []byte, offset int64) error

PatchFile writes bb at offset.

func Permissions added in v0.5.0 

func Permissions(rs io.ReadSeeker, conf *model.Configuration) (p int, err error)

Permissions returns user access permissions for rs.

func PermissionsList added in v0.14.0 

func PermissionsList(rs io.ReadSeeker, conf *model.Configuration) ([]string, error)

PermissionsList returns formatted user access permissions for rs.

func Poster added in v0.4.1 

func Poster(rs io.ReadSeeker, outDir, fileName string, selectedPages []string, cut *model.Cut, conf *model.Configuration) (err error)

Poster applies cut for selected pages of rs and generates corresponding poster tiles in outDir. Each generated output is written atomically. Outputs completed for earlier pages remain if a later page fails.

func PosterFile added in v0.4.1 

func PosterFile(inFile, outDir, outFile string, selectedPages []string, cut *model.Cut, conf *model.Configuration) (err error)

PosterFile applies cut for selected pages of inFile and generates corresponding poster tiles in outDir. Each generated output is written atomically. Outputs completed for earlier pages remain if a later page fails.

func PrepareImportConfiguration added in v0.14.0 

func PrepareImportConfiguration(imp *pdfcpu.Import) (*pdfcpu.Import, error)

PrepareImportConfiguration applies image import defaults and validates the result without performing I/O.

func Properties added in v0.5.0 

func Properties(rs io.ReadSeeker, conf *model.Configuration) (m map[string]string, err error)

Properties returns rs's properties as recorded in infoDict.

func ReadAndValidate added in v0.7.0 

func ReadAndValidate(rs io.ReadSeeker, conf *model.Configuration) (ctx *model.Context, err error)

ReadAndValidate returns a model.Context of rs ready for processing.

func ReadContext added in v0.1.18 

func ReadContext(rs io.ReadSeeker, conf *model.Configuration) (ctx *model.Context, err error)

ReadContext uses an io.ReadSeeker to build an internal structure holding its cross reference table aka the Context.

func ReadContextFile added in v0.2.3 

func ReadContextFile(inFile string) (*model.Context, error)

ReadContextFile returns inFile's validated context.

func ReadValidateAndOptimize added in v0.5.0 

func ReadValidateAndOptimize(rs io.ReadSeeker, conf *model.Configuration) (ctx *model.Context, err error)

ReadValidateAndOptimize returns an optimized model.Context of rs ready for processing a specific command. conf.Cmd is expected to be configured properly.

func RemainingPagesForPageRemoval added in v0.7.0 

func RemainingPagesForPageRemoval(pageCount int, pageSelection []string, log bool) (types.IntSet, error)

RemainingPagesForPageRemoval remaining pages for page removal.

func RemoveAnnotations added in v0.3.12 

func RemoveAnnotations(rs io.ReadSeeker, w io.Writer, selectedPages, idsAndTypes []string, objNrs []int, conf *model.Configuration) (err error)

RemoveAnnotations removes annotations for selected pages by id and object number from a PDF context read from rs and writes the result to w.

func RemoveAnnotationsAsIncrement added in v0.3.12 

func RemoveAnnotationsAsIncrement(rws io.ReadWriteSeeker, selectedPages, idsAndTypes []string, objNrs []int, conf *model.Configuration) (err error)

RemoveAnnotationsAsIncrement removes annotations for selected pages by ids and object number from a PDF context read from rs and writes out a PDF increment.

func RemoveAnnotationsFile added in v0.3.12 

func RemoveAnnotationsFile(inFile, outFile string, selectedPages, idsAndTypes []string, objNrs []int, conf *model.Configuration, incr bool) (err error)

RemoveAnnotationsFile removes annotations for selected pages by id and object number from a PDF context read from inFile and writes the result to outFile.

func RemoveAttachments 

func RemoveAttachments(rs io.ReadSeeker, w io.Writer, files []string, conf *model.Configuration) (err error)

RemoveAttachments deletes embedded files from a PDF context read from rs and writes the result to w.

func RemoveAttachmentsFile added in v0.2.3 

func RemoveAttachmentsFile(inFile, outFile string, files []string, conf *model.Configuration) error

RemoveAttachmentsFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.

Example

ExampleRemoveAttachmentsFile demonstrates remove attachments file. 

// Remove 1 attachment from in.pdf.
RemoveAttachmentsFile("in.pdf", "", []string{"img.jpg"}, nil)

// Remove all attachments from in.pdf
RemoveAttachmentsFile("in.pdf", "", nil, nil)

func RemoveBookmarks added in v0.5.0 

func RemoveBookmarks(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

RemoveBookmarks deletes bookmarks from rs and writes the result to w.

func RemoveBookmarksFile added in v0.5.0 

func RemoveBookmarksFile(inFile, outFile string, conf *model.Configuration) (err error)

RemoveBookmarksFile deletes bookmarks from inFile and writes the result to outFile.

func RemoveBoxes added in v0.3.8 

func RemoveBoxes(rs io.ReadSeeker, w io.Writer, selectedPages []string, pb *model.PageBoundaries, conf *model.Configuration) (err error)

RemoveBoxes removes page boundaries as specified in pb for selected pages of rs and writes result to w.

func RemoveBoxesFile added in v0.3.8 

func RemoveBoxesFile(inFile, outFile string, selectedPages []string, pb *model.PageBoundaries, conf *model.Configuration) (err error)

RemoveBoxesFile removes page boundaries as specified in pb for selected pages of inFile and writes result to outFile.

func RemoveFormFields added in v0.4.0 

func RemoveFormFields(rs io.ReadSeeker, w io.Writer, fieldIDsOrNames []string, conf *model.Configuration) (err error)

RemoveFormFields deletes form fields in rs and writes the result to w.

func RemoveFormFieldsFile added in v0.4.0 

func RemoveFormFieldsFile(inFile, outFile string, fieldIDsOrNames []string, conf *model.Configuration) (err error)

RemoveFormFieldsFile deletes form fields in inFile and writes the result to outFile.

func RemoveKeywords added in v0.3.2 

func RemoveKeywords(rs io.ReadSeeker, w io.Writer, keywords []string, conf *model.Configuration) (err error)

RemoveKeywords deletes keywords from rs's infodict and writes the result to w.

func RemoveKeywordsFile added in v0.3.2 

func RemoveKeywordsFile(inFile, outFile string, keywords []string, conf *model.Configuration) error

RemoveKeywordsFile deletes keywords from inFile's infodict and writes the result to outFile.

func RemovePages added in v0.2.3 

func RemovePages(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *model.Configuration) (err error)

RemovePages removes selected pages from rs and writes the result to w.

func RemovePagesFile added in v0.2.3 

func RemovePagesFile(inFile, outFile string, selectedPages []string, conf *model.Configuration) (err error)

RemovePagesFile removes selected inFile pages and writes the result to outFile.

Example

ExampleRemovePagesFile demonstrates remove pages file. 

// Remove pages 2 and 8 of in.pdf.
RemovePagesFile("in.pdf", "", []string{"2", "8"}, nil)

// Remove first 2 pages of in.pdf.
RemovePagesFile("in.pdf", "", []string{"-2"}, nil)

// Remove all pages >= 10 of in.pdf.
RemovePagesFile("in.pdf", "", []string{"10-"}, nil)

func RemoveProperties added in v0.3.2 

func RemoveProperties(rs io.ReadSeeker, w io.Writer, properties []string, conf *model.Configuration) (err error)

RemoveProperties deletes properties from rs's infodict and writes the result to w.

func RemovePropertiesFile added in v0.3.2 

func RemovePropertiesFile(inFile, outFile string, properties []string, conf *model.Configuration) error

RemovePropertiesFile deletes properties from inFile's infodict and writes the result to outFile.

func RemoveSignatures added in v0.12.0 

func RemoveSignatures(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

RemoveSignatures removes all digital signatures from rs and writes to w.

func RemoveSignaturesFile added in v0.12.0 

func RemoveSignaturesFile(inFile, outFile string, conf *model.Configuration) (err error)

RemoveSignaturesFile removes all digital signatures from inFile and writes to outFile if provided else overwrites inFile.

func RemoveWatermarks added in v0.2.5 

func RemoveWatermarks(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *model.Configuration) (err error)

RemoveWatermarks removes watermarks from all pages selected in rs and writes the result to w.

func RemoveWatermarksFile added in v0.2.5 

func RemoveWatermarksFile(inFile, outFile string, selectedPages []string, conf *model.Configuration) (err error)

RemoveWatermarksFile removes watermarks from all selected pages of inFile and writes the result to outFile.

Example

ExampleRemoveWatermarksFile demonstrates remove watermarks file. 

// Add a "Demo" stamp to all pages of in.pdf along the diagonal running from lower left to upper right.
onTop := true
update := false
wm, _ := TextWatermark("Demo", "", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Update stamp for correction:
update = true
wm, _ = TextWatermark("Confidential", "", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Add another watermark on top of page 1
wm, _ = TextWatermark("Footer stamp", "c:.5 1 1, pos:bc", onTop, update, types.POINTS)
AddWatermarksFile("in.pdf", "", nil, wm, nil)

// Remove watermark on page 1
RemoveWatermarksFile("in.pdf", "", []string{"1"}, nil)

// Remove all watermarks
RemoveWatermarksFile("in.pdf", "", nil, nil)

func ResetFormFields added in v0.4.0 

func ResetFormFields(rs io.ReadSeeker, w io.Writer, fieldIDsOrNames []string, conf *model.Configuration) (err error)

ResetFormFields resets form fields of rs and writes the result to w.

func ResetFormFieldsFile added in v0.4.0 

func ResetFormFieldsFile(inFile, outFile string, fieldIDsOrNames []string, conf *model.Configuration) (err error)

ResetFormFieldsFile resets form fields of inFile and writes the result to outFile.

func ResetPageLayout added in v0.6.0 

func ResetPageLayout(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

ResetPageLayout resets rs's page layout and writes the result to w. It is idempotent and writes output even when rs has no page layout.

func ResetPageLayoutFile added in v0.6.0 

func ResetPageLayoutFile(inFile, outFile string, conf *model.Configuration) (err error)

ResetPageLayoutFile resets inFile's page layout and writes the result to outFile. It is idempotent and writes output even when inFile has no page layout.

func ResetPageMode added in v0.6.0 

func ResetPageMode(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

ResetPageMode resets rs's page mode and writes the result to w. It is idempotent and writes output even when rs has no page mode.

func ResetPageModeFile added in v0.6.0 

func ResetPageModeFile(inFile, outFile string, conf *model.Configuration) (err error)

ResetPageModeFile resets inFile's page mode and writes the result to outFile. It is idempotent and writes output even when inFile has no page mode.

func ResetViewerPreferences added in v0.6.0 

func ResetViewerPreferences(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

ResetViewerPreferences resets rs's viewer preferences and writes the result to w. If rs has no viewer preferences, it still writes the unchanged PDF and returns success.

func ResetViewerPreferencesFile added in v0.6.0 

func ResetViewerPreferencesFile(inFile, outFile string, conf *model.Configuration) (err error)

ResetViewerPreferencesFile resets inFile's viewer preferences and writes the result to outFile. If inFile has no viewer preferences, it still writes the unchanged PDF and returns success.

func Resize added in v0.4.0 

func Resize(rs io.ReadSeeker, w io.Writer, selectedPages []string, resize *model.Resize, conf *model.Configuration) (err error)

Resize applies resizeConf for selected pages of rs and writes result to w.

func ResizeFile added in v0.4.0 

func ResizeFile(inFile, outFile string, selectedPages []string, resize *model.Resize, conf *model.Configuration) (err error)

ResizeFile applies resizeConf for selected pages of inFile and writes result to outFile.

func Rotate added in v0.1.20 

func Rotate(rs io.ReadSeeker, w io.Writer, rotation int, selectedPages []string, conf *model.Configuration) (err error)

Rotate rotates selected pages of rs clockwise by rotation degrees and writes the result to w.

func RotateFile added in v0.2.3 

func RotateFile(inFile, outFile string, rotation int, selectedPages []string, conf *model.Configuration) (err error)

RotateFile rotates selected pages of inFile clockwise by rotation degrees and writes the result to outFile.

Example

ExampleRotateFile demonstrates rotate file. 

// Rotate all pages of in.pdf, clockwise by 90 degrees and write the result to out.pdf.
RotateFile("in.pdf", "out.pdf", 90, nil, nil)

// Rotate the first page of in.pdf by 180 degrees.
// If you want to modify the original file, pass an empty string as outFile.
RotateFile("in.pdf", "", 180, []string{"1"}, nil)

func SetPageLayout added in v0.6.0 

func SetPageLayout(rs io.ReadSeeker, w io.Writer, val model.PageLayout, conf *model.Configuration) (err error)

SetPageLayout sets rs's page layout and writes the result to w.

func SetPageLayoutFile added in v0.6.0 

func SetPageLayoutFile(inFile, outFile string, val model.PageLayout, conf *model.Configuration) (err error)

SetPageLayoutFile sets inFile's page layout and writes the result to outFile.

func SetPageMode added in v0.6.0 

func SetPageMode(rs io.ReadSeeker, w io.Writer, val model.PageMode, conf *model.Configuration) (err error)

SetPageMode sets rs's page mode and writes the result to w.

func SetPageModeFile added in v0.6.0 

func SetPageModeFile(inFile, outFile string, val model.PageMode, conf *model.Configuration) (err error)

SetPageModeFile sets inFile's page mode and writes the result to outFile.

func SetPermissions added in v0.2.3 

func SetPermissions(rs io.ReadSeeker, w io.Writer, conf *model.Configuration) (err error)

SetPermissions sets user access permissions. inFile has to be encrypted. A configuration containing the current passwords is required.

func SetPermissionsFile added in v0.2.3 

func SetPermissionsFile(inFile, outFile string, conf *model.Configuration) error

SetPermissionsFile sets inFile's user access permissions. inFile has to be encrypted. A configuration containing the current passwords is required.

Example

ExampleSetPermissionsFile demonstrates set permissions file. 

// Setting all permissions for the AES-256 encrypted in.pdf.
conf := model.NewAESConfiguration("upw", "opw", 256)
conf.Permissions = model.PermissionsAll
SetPermissionsFile("in.pdf", "", conf)

// Restricting permissions for the AES-256 encrypted in.pdf.
conf = model.NewAESConfiguration("upw", "opw", 256)
conf.Permissions = model.PermissionsNone
SetPermissionsFile("in.pdf", "", conf)

func SetViewerPreferences added in v0.6.0 

func SetViewerPreferences(rs io.ReadSeeker, w io.Writer, vp model.ViewerPreferences, conf *model.Configuration) (err error)

SetViewerPreferences sets rs's viewer preferences and writes the result to w.

func SetViewerPreferencesFile added in v0.6.0 

func SetViewerPreferencesFile(inFile, outFile string, vp model.ViewerPreferences, conf *model.Configuration) (err error)

SetViewerPreferencesFile sets inFile's viewer preferences and writes the result to outFile.

func SetViewerPreferencesFileFromJSONBytes added in v0.6.0 

func SetViewerPreferencesFileFromJSONBytes(inFile, outFile string, jsonBytes []byte, conf *model.Configuration) (err error)

SetViewerPreferencesFileFromJSONBytes sets inFile's viewer preferences corresponding to jsonBytes and writes the result to outFile.

func SetViewerPreferencesFileFromJSONFile added in v0.6.0 

func SetViewerPreferencesFileFromJSONFile(inFilePDF, outFilePDF, inFileJSON string, conf *model.Configuration) error

SetViewerPreferencesFileFromJSONFile sets inFile's viewer preferences corresponding to inFileJSON and writes the result to outFile.

func SetViewerPreferencesFromJSONBytes added in v0.6.0 

func SetViewerPreferencesFromJSONBytes(rs io.ReadSeeker, w io.Writer, jsonBytes []byte, conf *model.Configuration) error

SetViewerPreferencesFromJSONBytes sets rs's viewer preferences corresponding to jsonBytes and writes the result to w.

func SetViewerPreferencesFromJSONReader added in v0.6.0 

func SetViewerPreferencesFromJSONReader(rs io.ReadSeeker, w io.Writer, rd io.Reader, conf *model.Configuration) error

SetViewerPreferencesFromJSONReader sets rs's viewer preferences corresponding to rd and writes the result to w.

func Split 

func Split(rs io.ReadSeeker, outDir, fileName string, span int, conf *model.Configuration) (err error)

Split generates a sequence of PDF files in outDir for the PDF stream read from rs obeying given split span. If span == 1 splitting results in single page PDFs. If span == 0 we split along given bookmarks (level 1 only). Default span: 1

func SplitByPageNr added in v0.6.0 

func SplitByPageNr(rs io.ReadSeeker, outDir, fileName string, pageNrs []int, conf *model.Configuration) (err error)

SplitByPageNr splits rs before the specified 1-based page numbers and writes result files to outDir. Page numbers must be sorted, unique, and at least 2.

func SplitByPageNrFile added in v0.6.0 

func SplitByPageNrFile(inFile, outDir string, pageNrs []int, conf *model.Configuration) (err error)

SplitByPageNrFile splits inFile before the specified 1-based page numbers and writes result files to outDir. Page numbers must be sorted, unique, and at least 2.

func SplitFile added in v0.2.3 

func SplitFile(inFile, outDir string, span int, conf *model.Configuration) (err error)

SplitFile generates a sequence of PDF files in outDir for inFile obeying given split span. If span == 1 splitting results in single page PDFs. If span == 0 we split along given bookmarks (level 1 only). Default span: 1

Example

ExampleSplitFile demonstrates split file. 

// Create single page PDFs for in.pdf in outDir using the default configuration.
SplitFile("in.pdf", "outDir", 1, nil)

// Create dual page PDFs for in.pdf in outDir using the default configuration.
SplitFile("in.pdf", "outDir", 2, nil)

// Create a sequence of PDFs representing bookmark sections.
SplitFile("in.pdf", "outDir", 0, nil)

func TextWatermark added in v0.3.4 

func TextWatermark(text, desc string, onTop, update bool, u types.DisplayUnit) (*model.Watermark, error)

TextWatermark returns a text watermark configuration.

func Trim 

func Trim(rs io.ReadSeeker, w io.Writer, selectedPages []string, conf *model.Configuration) (err error)

Trim generates a trimmed version of rs containing all selected pages and writes the result to w.

func TrimFile added in v0.2.3 

func TrimFile(inFile, outFile string, selectedPages []string, conf *model.Configuration) (err error)

TrimFile generates a trimmed version of inFile containing all selected pages and writes the result to outFile.

Example

ExampleTrimFile demonstrates trim file. 

// Create a trimmed version of in.pdf containing odd page numbers only.
TrimFile("in.pdf", "outFile", []string{"odd"}, nil)

// Create a trimmed version of in.pdf containing the first two pages only.
// If you want to modify the original file, pass an empty string for outFile.
TrimFile("in.pdf", "", []string{"1-2"}, nil)

func UnlockFormFields added in v0.4.0 

func UnlockFormFields(rs io.ReadSeeker, w io.Writer, fieldIDsOrNames []string, conf *model.Configuration) (err error)

UnlockFormFields makes form fields in rs writable and writes the result to w.

func UnlockFormFieldsFile added in v0.4.0 

func UnlockFormFieldsFile(inFile, outFile string, fieldIDsOrNames []string, conf *model.Configuration) (err error)

UnlockFormFieldsFile makes form fields of inFile writable and writes the result to outFile.

func UpdateImageWatermarksFile added in v0.3.4 

func UpdateImageWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *model.Configuration) error

UpdateImageWatermarksFile adds image stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func UpdateImages added in v0.9.0 

func UpdateImages(rs io.ReadSeeker, rd io.Reader, w io.Writer, objNr, pageNr int, id string, conf *model.Configuration) (err error)

UpdateImages replaces the XObject identified by objNr or (pageNr and resourceId).

func UpdateImagesFile added in v0.9.0 

func UpdateImagesFile(inFile, imageFile, outFile string, objNr, pageNr int, id string, conf *model.Configuration) (err error)

UpdateImagesFile replaces the XObject identified by objNr or (pageNr and resourceId).

func UpdatePDFWatermarksFile added in v0.3.4 

func UpdatePDFWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, fileName, desc string, conf *model.Configuration) error

UpdatePDFWatermarksFile adds PDF stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func UpdateTextWatermarksFile added in v0.3.4 

func UpdateTextWatermarksFile(inFile, outFile string, selectedPages []string, onTop bool, text, desc string, conf *model.Configuration) error

UpdateTextWatermarksFile adds text stamps/watermarks to all selected pages of inFile and writes the result to outFile.

func Validate 

func Validate(rs io.ReadSeeker, conf *model.Configuration) (err error)

Validate validates a PDF stream read from rs.

func ValidateContext added in v0.1.18 

func ValidateContext(ctx *model.Context) error

ValidateContext validates ctx.

func ValidateFile added in v0.2.3 

func ValidateFile(inFile string, conf *model.Configuration) (err error)

ValidateFile validates inFile.

Example

ExampleValidateFile demonstrates validate file. 

// Use the default configuration to validate in.pdf.
ValidateFile("in.pdf", nil)

func ValidateFiles added in v0.3.13 

func ValidateFiles(inFiles []string, conf *model.Configuration) error

ValidateFiles validates inFiles.

func ValidateImportImagesOutput added in v0.14.0 

func ValidateImportImagesOutput(imgFiles []string, outFile string) error

ValidateImportImagesOutput validates that outFile does not alias a file-based image input. A "-" image input denotes stdin and is ignored.

func ValidateSignatures added in v0.10.0 

func ValidateSignatures(inFile string, all bool, conf *model.Configuration) (results []*model.SignatureValidationResult, err error)

ValidateSignatures validates signature integrity, reports available trust evidence and performs a best-effort local assessment.

func ValidateSignaturesFile added in v0.10.0 

func ValidateSignaturesFile(inFile string, all, full bool, conf *model.Configuration) ([]string, error)

ValidateSignaturesFile presents observed signature, certificate, timestamp and revocation evidence together with a local assessment. all: processes all signatures meaning not only the authoritative/certified signature.. full: detailed output including certificate paths, observed evidence and problems encountered.

func ValidateSignaturesRaw added in v0.14.0 

func ValidateSignaturesRaw(
	rs ReadSeekerAt,
	all bool,
	conf *model.Configuration,
) (results []*model.SignatureValidationResult, err error)

ValidateSignaturesRaw validates signature integrity, reports available trust evidence and performs a best-effort local assessment.

func ValidateUpdateImagesOutput added in v0.14.0 

func ValidateUpdateImagesOutput(imageFile, outFile string) error

ValidateUpdateImagesOutput ensures outFile does not alias imageFile.

func ViewerPreferences added in v0.6.0 

func ViewerPreferences(rs io.ReadSeeker, conf *model.Configuration) (vp *model.ViewerPreferences, v *model.Version, err error)

ViewerPreferences returns rs's viewer preferences.

func ViewerPreferencesFile added in v0.6.0 

func ViewerPreferencesFile(inFile string, all bool, conf *model.Configuration) (vp *model.ViewerPreferences, err error)

ViewerPreferencesFile returns inFile's viewer preferences.

func WatermarkContext added in v0.3.1 

func WatermarkContext(ctx *model.Context, selectedPages types.IntSet, wm *model.Watermark) error

WatermarkContext applies wm for selected pages to ctx.

func Write 

func Write(ctx *model.Context, w io.Writer, conf *model.Configuration) error

Write writes ctx using w.

func WriteContentToDisk added in v0.13.0 

func WriteContentToDisk(outDir, fnBase string) func(io.Reader, int) error

WriteContentToDisk returns a closure for writing content to disk.

func WriteContext added in v0.1.18 

func WriteContext(ctx *model.Context, w io.Writer) (err error)

WriteContext writes ctx to w.

func WriteContextFile added in v0.3.1 

func WriteContextFile(ctx *model.Context, outFile string) (err error)

WriteContextFile writes ctx to outFile.

func WriteFontToDisk added in v0.13.0 

func WriteFontToDisk(outDir, fnBase string) func(pdfcpu.Font) error

WriteFontToDisk returns a closure for writing a font file to disk.

func WriteImageToDisk added in v0.13.0 

func WriteImageToDisk(outDir, fileName string) func(model.Image, bool, int) error

WriteImageToDisk returns a closure for writing an image to disk.

func WriteIncr added in v0.7.0 

func WriteIncr(ctx *model.Context, rws io.ReadWriteSeeker, conf *model.Configuration) error

WriteIncr writes ctx as increment using rws.

func WriteIncrement added in v0.3.12 

func WriteIncrement(ctx *model.Context, w io.Writer) (err error)

WriteIncrement writes a PDF increment for ctx to w.

func WriteMetadataToDisk added in v0.13.0 

func WriteMetadataToDisk(outDir, fnBase string) func(pdfcpu.Metadata) error

WriteMetadataToDisk returns a closure for writing metadata to disk.

func WritePageToDisk added in v0.13.0 

func WritePageToDisk(outDir, fnBase string) func(io.Reader, int) error

WritePageToDisk returns a closure for writing a single page PDF to disk.

func Zoom added in v0.7.0 

func Zoom(rs io.ReadSeeker, w io.Writer, selectedPages []string, zoom *model.Zoom, conf *model.Configuration) (err error)

Zoom applies zoom for selected pages of rs and writes the result to w.

func ZoomFile added in v0.7.0 

func ZoomFile(inFile, outFile string, selectedPages []string, zoom *model.Zoom, conf *model.Configuration) (err error)

ZoomFile applies zoom for selected pages of inFile and writes the result to outFile.

Types

type PageSpan added in v0.4.0 

type PageSpan struct {
	// From is the first page number of this span.
	From int

	// Thru is the last page number of this span.
	Thru int

	// Reader provides the PDF stream for this span.
	Reader io.Reader
}

PageSpan represents a contiguous page range and its generated PDF stream.

func SplitRaw added in v0.4.0 

func SplitRaw(rs io.ReadSeeker, span int, conf *model.Configuration) (ps []*PageSpan, err error)

SplitRaw returns page spans for the PDF stream read from rs obeying given split span. If span == 1 splitting results in single page PDFs. If span == 0 we split along given bookmarks (level 1 only). Default span: 1 SplitRaw is not used within this repository.

type ReadSeekerAt added in v0.14.0 

type ReadSeekerAt interface {
	io.ReadSeeker
	io.ReaderAt
}

ReadSeekerAt supports PDF parsing and positional signature verification.

type UnsupportedResourceError added in v0.14.0 

type UnsupportedResourceError struct {
	// Err contains the contextual errors for all skipped resources.
	Err error
}

UnsupportedResourceError aggregates resources skipped during an otherwise successful extraction.

func (*UnsupportedResourceError) Error added in v0.14.0 

func (e *UnsupportedResourceError) Error() string

Error returns the aggregated unsupported-resource error text.

func (*UnsupportedResourceError) Unwrap added in v0.14.0 

func (e *UnsupportedResourceError) Unwrap() error

Unwrap returns the aggregated unsupported-resource causes.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.