pdftk

Documentation

Overview

Package pdftk provides a module which abstracts the CLI tool PDFtk and implements the gotenberg.PDFEngine interface.

Index

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

Types

type PDFtk

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

PDFtk abstracts the CLI tool PDFtk and implements the gotenberg.PDFEngine interface.

func (PDFtk) Convert

func (engine PDFtk) Convert(_ context.Context, _ *zap.Logger, format, _, _ string) error

Convert is not available for this PDF engine.

func (PDFtk) Descriptor

func (PDFtk) Descriptor() gotenberg.ModuleDescriptor

Descriptor returns a PDFtk's module descriptor.

func (PDFtk) Merge

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

Merge merges the given PDFs into a unique PDF.

func (PDFtk) Metrics

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

Metrics returns the metrics.

func (*PDFtk) Provision

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

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

func (PDFtk) Validate

func (engine PDFtk) Validate() error

Validate validates the module properties.