qpdf

Documentation

Overview

Package qpdf provides an implementation of the gotenberg.PdfEngine interface using the QPDF command-line tool. This package allows for the merging of PDF files but does not support conversion to specific PDF formats. The path to the QPDF binary must be specified using the QPDK_BIN_PATH environment variable.

See: https://github.com/qpdf/qpdf.

Index

• type QPdf
  • func (engine *QPdf) Convert(ctx context.Context, logger *zap.Logger, formats gotenberg.PdfFormats, ...) error
  • func (engine *QPdf) Descriptor() gotenberg.ModuleDescriptor
  • func (engine *QPdf) Merge(ctx context.Context, logger *zap.Logger, inputPaths []string, ...) error
  • func (engine *QPdf) Metrics() ([]gotenberg.Metric, error)
  • func (engine *QPdf) Provision(ctx *gotenberg.Context) error
  • func (engine *QPdf) Validate() error

Types

type QPdf

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

QPdf abstracts the CLI tool QPDF and implements the gotenberg.PdfEngine interface.

func (*QPdf) Convert

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

Convert is not available in this implementation.

func (*QPdf) Descriptor

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

Descriptor returns a QPdf's module descriptor.

func (*QPdf) Merge

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

Merge combines multiple PDFs into a single PDF.

func (*QPdf) Metrics

func (engine *QPdf) Metrics() ([]gotenberg.Metric, error)

Metrics returns the metrics.

func (*QPdf) Provision

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

Provision sets the modules properties.

func (*QPdf) Validate

func (engine *QPdf) Validate() error

Validate validates the module properties.