qpdf

Documentation

Overview

Package qpdf provides a module which abstracts the CLI tool QPDF and implements the gotenberg.PDFEngine interface.

Index

• type QPDF
  • func (engine QPDF) Convert(_ context.Context, _ *zap.Logger, format, _, _ string) error
  • func (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(_ *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(_ context.Context, _ *zap.Logger, format, _, _ string) error

Convert is not available for this PDF engine.

func (QPDF) Descriptor

func (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 merges the given PDFs into a unique PDF.

func (QPDF) Metrics

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

Metrics returns the metrics.

func (*QPDF) Provision

func (engine *QPDF) Provision(_ *gotenberg.Context) error

Provision sets the modules properties. It returns an error if the environment variable QPDF_BIN_PATH is not set.

func (QPDF) Validate

func (engine QPDF) Validate() error

Validate validates the module properties.