pdfcpu

Documentation

Overview

Package pdfcpu provides an implementation of the gotenberg.PdfEngine interface using the pdfcpu command-line tool. This package allows for:

1. The merging of PDF files. 2. The splitting of PDF files.

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

Index

• type PdfCpu
  • func (engine *PdfCpu) Convert(ctx context.Context, logger *zap.Logger, formats gotenberg.PdfFormats, ...) error
  • func (engine *PdfCpu) Debug() map[string]interface{}
  • func (engine *PdfCpu) Descriptor() gotenberg.ModuleDescriptor
  • func (engine *PdfCpu) Flatten(ctx context.Context, logger *zap.Logger, inputPath string) error
  • func (engine *PdfCpu) Merge(ctx context.Context, logger *zap.Logger, inputPaths []string, ...) error
  • func (engine *PdfCpu) Provision(ctx *gotenberg.Context) error
  • func (engine *PdfCpu) ReadMetadata(ctx context.Context, logger *zap.Logger, inputPath string) (map[string]interface{}, error)
  • func (engine *PdfCpu) Split(ctx context.Context, logger *zap.Logger, mode gotenberg.SplitMode, ...) ([]string, error)
  • func (engine *PdfCpu) Validate() error
  • func (engine *PdfCpu) WriteMetadata(ctx context.Context, logger *zap.Logger, metadata map[string]interface{}, ...) 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 *zap.Logger, formats gotenberg.PdfFormats, inputPath, outputPath string) error

Convert is not available in this implementation.

func (*PdfCpu) Debug

func (engine *PdfCpu) Debug() map[string]interface{}

Debug returns additional debug data.

func (*PdfCpu) Descriptor

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

Descriptor returns a PdfCpu's module descriptor.

func (*PdfCpu) Flatten

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

Flatten is not available in this implementation.

func (*PdfCpu) Merge

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

Merge combines multiple PDFs into a single PDF.

func (*PdfCpu) Provision

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

Provision sets the engine properties.

func (*PdfCpu) ReadMetadata

func (engine *PdfCpu) ReadMetadata(ctx context.Context, logger *zap.Logger, inputPath string) (map[string]interface{}, error)

ReadMetadata is not available in this implementation.

func (*PdfCpu) Split

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

Split splits a given PDF file.

func (*PdfCpu) Validate

func (engine *PdfCpu) Validate() error

Validate validates the module properties.

func (*PdfCpu) WriteMetadata

func (engine *PdfCpu) WriteMetadata(ctx context.Context, logger *zap.Logger, metadata map[string]interface{}, inputPath string) error

WriteMetadata is not available in this implementation.