pdf

package module

Go to main page

Versions in this module

v0

v0.8.0

Oct 10, 2026

Changes in this version

type LayoutOptions

+ KeepOffPageText bool

v0.7.0

Sep 24, 2026

Changes in this version

type LayoutOptions

+ KeepDuplicateGlyphs bool

type Options

+ IgnoreAnnotationAppearances bool

v0.6.0

Aug 21, 2026

Changes in this version

type Options

+ OCRSelect func(page Page) bool

type Page

+ ImageCount int

v0.5.0

Aug 21, 2026

Changes in this version

+ var ErrImageTooLarge = errors.New("pdf: image exceeds the pixel limit")

+ type Image struct

+ BitsPerComponent int

+ ColorSpace string

+ Components int

+ Data []byte

+ Filter string

+ Height int

+ ImageMask bool

+ Inline bool

+ Width int

+ func (im Image) Bounds() Rect

+ func (im Image) Decode() (image.Image, error)

+ func (im Image) Quad() Quad

+ func (im Image) ToPage(x, y float64) Point

type Limits

+ MaxImageBytesPerPage int

+ MaxImagePixels int

+ MaxImagesPerPage int

+ type OCRPolicy uint8

+ const OCRAllPages

+ const OCRImagePages

+ const OCRTextlessPages

type Options

+ IncludeImages bool

+ OCRPolicy OCRPolicy

type Page

+ Images []Image

+ OCRGlyphs int

v0.4.0

Aug 21, 2026

Changes in this version

type Glyph

+ Ascent Point

+ Descent Point

type Options

+ Concurrency int

v0.3.0

Aug 21, 2026

Changes in this version

+ var ErrPasswordRequired = crypt.ErrPasswordRequired

+ type Annotation struct

+ Contents string

+ Destination Destination

+ Rect Rect

+ Subtype string

+ Title string

+ URL string

+ type CMapResolver func(name string) ([]byte, error)

+ type Destination struct

+ Name string

+ Page int

+ X float64

+ Y float64

+ Zoom float64

type Document

+ FormFields []FormField

+ Metadata Metadata

+ Outlines []Outline

+ PageCount int

+ Warnings []Warning

+ func ExtractPages(ctx context.Context, r io.ReaderAt, size int64, opts Options, ...) (*Document, error)

+ func ExtractWithOptions(ctx context.Context, r io.ReaderAt, size int64, opts Options) (*Document, error)

+ type FormField struct

+ AlternateName string

+ Name string

+ Page int

+ Type string

+ Value string

type Glyph

+ Baseline Line

+ Direction Point

+ Quad Quad

+ type LayoutMode uint8

+ const LayoutColumns

+ const LayoutContentOrder

+ const LayoutPosition

+ type LayoutOptions struct

+ Mode LayoutMode

+ type Limits struct

+ MaxFormDepth int

+ MaxGlyphsPerPage int

+ MaxOperatorsPerPage int

+ MaxStreamBytes int

+ type Line struct

+ End Point

+ Start Point

+ type Metadata struct

+ Author string

+ CreationDate string

+ Creator string

+ Custom map[string]string

+ Keywords string

+ ModifiedDate string

+ Producer string

+ Subject string

+ Title string

+ Trapped string

+ XMP []byte

+ type OCR interface

+ ExtractPage func(context.Context, OCRRequest) ([]Glyph, error)

+ type OCRFunc func(context.Context, OCRRequest) ([]Glyph, error)

+ func (f OCRFunc) ExtractPage(ctx context.Context, req OCRRequest) ([]Glyph, error)

+ type OCRRequest struct

+ Page Page

+ PageNumber int

+ Reader io.ReaderAt

+ Size int64

+ type Options struct

+ CMapResolver CMapResolver

+ IgnoreArtifacts bool

+ IncludeAnnotations bool

+ IncludeFormValues bool

+ IncludeMetadata bool

+ IncludeOutlines bool

+ Layout LayoutOptions

+ Limits Limits

+ OCR OCR

+ Pages []PageRange

+ Password string

+ PreserveLigatures bool

+ Strict bool

+ type Outline struct

+ Children []Outline

+ Destination Destination

+ Title string

type Page

+ Annotations []Annotation

+ CropBox Rect

+ MediaBox Rect

+ Number int

+ Rotation int

+ Warnings []Warning

+ func (p Page) GlyphsIn(region Rect) []Glyph

+ func (p Page) TextIn(region Rect, layout LayoutOptions) string

+ func (p Page) TextWithOptions(layout LayoutOptions) string

+ type PageRange struct

+ First int

+ Last int

+ type Point struct

+ X float64

+ Y float64

+ type Quad [4]Point

+ type Rect struct

+ MaxX float64

+ MaxY float64

+ MinX float64

+ MinY float64

+ type StrictError struct

+ Warning Warning

+ func (e *StrictError) Error() string

+ func (e *StrictError) Unwrap() error

+ type Warning struct

+ Code WarningCode

+ Err error

+ Page int

+ func (w Warning) Error() string

+ func (w Warning) Unwrap() error

+ type WarningCode string

+ const WarningMalformedDocument

+ const WarningMalformedPage

+ const WarningOCR

+ const WarningStream

+ const WarningStreamLimit

+ const WarningUnsupported

+ const WarningWorkLimit

v0.2.1

Jul 15, 2026

v0.2.0

Jul 13, 2026

v0.1.0

Jul 13, 2026

Changes in this version

+ type Document struct

+ Pages []Page

+ func Extract(ctx context.Context, r io.ReaderAt, size int64) (doc *Document, err error)

+ func (d *Document) Text() string

+ type Glyph struct

+ Advance float64

+ Size float64

+ Text string

+ X float64

+ Y float64

+ type Page struct

+ Glyphs []Glyph

+ func (p Page) Text() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL