filter

Documentation

Overview

Package filter contains PDF filter implementations.

Index

• Constants
• Variables
• func DecodeStream(streamDict *types.PDFStreamDict) (err error)
• func EncodeStream(streamDict *types.PDFStreamDict) (err error)
• type Filter
  • func NewFilter(filterName string, decodeParms, encodeParms *types.PDFDict) (filter Filter, err error)

Constants

const EOD = '>'

EOD represents the end of data marker.

Variables

var (

	// ErrUnsupportedFilter signals an unsupported filter type.
	ErrUnsupportedFilter = errors.New("Filter not supported")
)

Functions

func DecodeStream

func DecodeStream(streamDict *types.PDFStreamDict) (err error)

DecodeStream decodes streamDict data by applying its filter pipeline.

func EncodeStream

func EncodeStream(streamDict *types.PDFStreamDict) (err error)

EncodeStream encodes stream dict data by applying its filter pipeline.

Types

type Filter

type Filter interface {
	Encode(r io.Reader) (*bytes.Buffer, error)
	Decode(r io.Reader) (*bytes.Buffer, error)
}

Filter defines an interface for encoding/decoding buffers.

func NewFilter

func NewFilter(filterName string, decodeParms, encodeParms *types.PDFDict) (filter Filter, err error)

NewFilter returns a filter for given filterName and an optional parameter dictionary.