pdfcpu

Documentation

Overview

Package pdfcpu implements gotenberg.PdfEngine using the pdfcpu command-line tool. Merges and splits PDF files.

See https://github.com/pdfcpu/pdfcpu.

Index

• type PdfCpu
  • func (engine *PdfCpu) Convert(ctx context.Context, logger *slog.Logger, formats gotenberg.PdfFormats, ...) error
  • func (engine *PdfCpu) Debug() map[string]any
  • func (engine *PdfCpu) Descriptor() gotenberg.ModuleDescriptor
  • func (engine *PdfCpu) EmbedFiles(ctx context.Context, logger *slog.Logger, filePaths []string, inputPath string) error
  • func (engine *PdfCpu) Encrypt(ctx context.Context, logger *slog.Logger, ...) error
  • func (engine *PdfCpu) Flatten(ctx context.Context, logger *slog.Logger, inputPath string) error
  • func (engine *PdfCpu) Merge(ctx context.Context, logger *slog.Logger, inputPaths []string, ...) error
  • func (engine *PdfCpu) PageCount(ctx context.Context, logger *slog.Logger, inputPath string) (int, error)
  • func (engine *PdfCpu) Provision(ctx *gotenberg.Context) error
  • func (engine *PdfCpu) ReadBookmarks(ctx context.Context, logger *slog.Logger, inputPath string) ([]gotenberg.Bookmark, error)
  • func (engine *PdfCpu) ReadMetadata(ctx context.Context, logger *slog.Logger, inputPath string) (map[string]any, error)
  • func (engine *PdfCpu) Rotate(ctx context.Context, logger *slog.Logger, inputPath string, angle int, ...) error
  • func (engine *PdfCpu) Split(ctx context.Context, logger *slog.Logger, mode gotenberg.SplitMode, ...) ([]string, error)
  • func (engine *PdfCpu) Stamp(ctx context.Context, logger *slog.Logger, inputPath string, ...) error
  • func (engine *PdfCpu) Validate() error
  • func (engine *PdfCpu) Watermark(ctx context.Context, logger *slog.Logger, inputPath string, ...) error
  • func (engine *PdfCpu) WriteBookmarks(ctx context.Context, logger *slog.Logger, inputPath string, ...) error
  • func (engine *PdfCpu) WriteMetadata(ctx context.Context, logger *slog.Logger, metadata map[string]any, ...) error

Types

type PdfCpu

type PdfCpu struct {
	// contains filtered or unexported fields
}

PdfCpu abstracts the CLI tool pdfcpu and implements the gotenberg.PdfEngine interface.

func (*PdfCpu) Convert

func (engine *PdfCpu) Convert(ctx context.Context, logger *slog.Logger, formats gotenberg.PdfFormats, inputPath, outputPath string) error

Convert is not available in this implementation.

func (*PdfCpu) Debug

func (engine *PdfCpu) Debug() map[string]any

Debug returns additional debug data.

func (*PdfCpu) Descriptor

func (engine *PdfCpu) Descriptor() gotenberg.ModuleDescriptor

Descriptor returns a PdfCpu's module descriptor.

func (*PdfCpu) EmbedFiles

func (engine *PdfCpu) EmbedFiles(ctx context.Context, logger *slog.Logger, filePaths []string, inputPath string) error

EmbedFiles embeds files into a PDF. All files are embedded as file attachments without modifying the main PDF content.

func (*PdfCpu) Encrypt

func (engine *PdfCpu) Encrypt(ctx context.Context, logger *slog.Logger, inputPath, userPassword, ownerPassword string) error

Encrypt adds password protection to a PDF file using pdfcpu.

func (*PdfCpu) Flatten

func (engine *PdfCpu) Flatten(ctx context.Context, logger *slog.Logger, inputPath string) error

Flatten is not available in this implementation.

func (*PdfCpu) Merge

func (engine *PdfCpu) Merge(ctx context.Context, logger *slog.Logger, inputPaths []string, outputPath string) error

Merge combines multiple PDFs into a single PDF.

func (*PdfCpu) PageCount

func (engine *PdfCpu) PageCount(ctx context.Context, logger *slog.Logger, inputPath string) (int, error)

PageCount is not available in this implementation.

func (*PdfCpu) Provision

func (engine *PdfCpu) Provision(ctx *gotenberg.Context) error

Provision sets the engine properties.

func (*PdfCpu) ReadBookmarks

func (engine *PdfCpu) ReadBookmarks(ctx context.Context, logger *slog.Logger, inputPath string) ([]gotenberg.Bookmark, error)

ReadBookmarks reads the document outline (bookmarks) of a PDF file using pdfcpu.

func (*PdfCpu) ReadMetadata

func (engine *PdfCpu) ReadMetadata(ctx context.Context, logger *slog.Logger, inputPath string) (map[string]any, error)

ReadMetadata is not available in this implementation.

func (*PdfCpu) Rotate

func (engine *PdfCpu) Rotate(ctx context.Context, logger *slog.Logger, inputPath string, angle int, pages string) error

Rotate rotates pages of a PDF file by the given angle using pdfcpu.

func (*PdfCpu) Split

func (engine *PdfCpu) Split(ctx context.Context, logger *slog.Logger, mode gotenberg.SplitMode, inputPath, outputDirPath string) ([]string, error)

Split splits a given PDF file.

func (*PdfCpu) Stamp

func (engine *PdfCpu) Stamp(ctx context.Context, logger *slog.Logger, inputPath string, stamp gotenberg.Stamp) error

Stamp applies a stamp (on top of page content) to a PDF file using pdfcpu.

func (*PdfCpu) Validate

func (engine *PdfCpu) Validate() error

Validate validates the module properties.

func (*PdfCpu) Watermark

func (engine *PdfCpu) Watermark(ctx context.Context, logger *slog.Logger, inputPath string, stamp gotenberg.Stamp) error

Watermark applies a watermark (behind page content) to a PDF file using pdfcpu.

func (*PdfCpu) WriteBookmarks

func (engine *PdfCpu) WriteBookmarks(ctx context.Context, logger *slog.Logger, inputPath string, bookmarks []gotenberg.Bookmark) error

WriteBookmarks adds a document outline (bookmarks) to a PDF file using pdfcpu.

func (*PdfCpu) WriteMetadata

func (engine *PdfCpu) WriteMetadata(ctx context.Context, logger *slog.Logger, metadata map[string]any, inputPath string) error

WriteMetadata is not available in this implementation.