mutool

Documentation

Overview

Package mutool wraps MuPDF's "mutool" command line program.

Index

• type Options
• type Wrapper
  • func New(opts Options) *Wrapper
  • func (w *Wrapper) CheckCommands(ctx context.Context) error
  • func (w *Wrapper) Draw(ctx context.Context, path string, pageNum int, r renderformat.Renderer) error
  • func (w *Wrapper) StructuredText(ctx context.Context, path string, r pagerange.Range) (_ *stext.Document, err error)
  • func (w *Wrapper) Validate(ctx context.Context, path string) error

Types

type Options

type Options struct {
	// Command and optional arguments for running mutool. Defaults to "mutool".
	MutoolCommand []string

	// Command and optional arguments for running xmllint. Defaults to
	// "xmllint".
	XmllintCommand []string
}

type Wrapper

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

func New

func New(opts Options) *Wrapper

func (*Wrapper) CheckCommands

func (w *Wrapper) CheckCommands(ctx context.Context) error

func (*Wrapper) Draw

func (w *Wrapper) Draw(ctx context.Context, path string, pageNum int, r renderformat.Renderer) error

Draw produces an image of a single page from a document.

func (*Wrapper) StructuredText

func (w *Wrapper) StructuredText(ctx context.Context, path string, r pagerange.Range) (_ *stext.Document, err error)

func (*Wrapper) Validate

func (w *Wrapper) Validate(ctx context.Context, path string) error

Validate checks whether the given file can be parsed successfully.