README
¶
go-poppler
A simple wrapper for the poppler pdf lib for Golang.
This go module exports a limited subset of Popplers functionalties.
Install dependencies
In order to use this module you need to install two packages. In Debian/Ubuntu this is done by:
apt-get install libpoppler-glib-dev libcairo2-dev
Usage
go get github.com/johbar/go-poppler
Improvements and performance considerations
This is a fork of timsat/go-poppler which is derived of cheggaaa/go-poppler.
This fork uses finalizers as a safeguard against memory leaks.
This enables you not to call document.Close() and page.Close() but let the GC do the clean-up work instead.
This might add a significant memory overhead in long-running high-throughput processes (like a webservice or batch processor), when a lot of Poppler objects in unmanaged/off-heap memory are being created. They are evicted by the finalizer but the GC might run too late to prevent a OOM as it doesn't take these into account when it schedules the next cycle.
One advantage of relying on finalizes solely might be an improved CPU utilization because they run on their own goroutine. So your main routine doesn't need to handle the clean-up. (But you can archive this in many other ways, I guess, e.g. by writing your own goroutine and using channels.)
Tl;dr: Be careful when relying on finalizers; do some (load) tests and watch your RAM!
Documentation
¶
Index ¶
- func Version() string
- type Color
- type Document
- type DocumentInfo
- type Image
- type Page
- func (p *Page) Close()
- func (p *Page) Duration() float64
- func (p *Page) Images() (results []Image)
- func (p *Page) Index() int
- func (p *Page) Label() string
- func (p *Page) Size() (width, height float64)
- func (p *Page) Text() string
- func (p *Page) TextAttributes() (results []TextAttributes)
- func (p *Page) TextLayout() (layouts []Rectangle)
- func (p *Page) TextLayoutAndAttrs() (result []TextEl)
- type Rectangle
- type TextAttributes
- type TextEl
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Document ¶
type Document struct {
// contains filtered or unexported fields
}
func (*Document) GetNAttachments ¶
func (*Document) HasAttachments ¶
func (*Document) Info ¶
func (d *Document) Info() DocumentInfo
type DocumentInfo ¶
type Image ¶
func (*Image) GetSurface ¶
func (im *Image) GetSurface() (cs *cairo.Surface)
type Page ¶
type Page struct {
// contains filtered or unexported fields
}
func (*Page) Close ¶
func (p *Page) Close()
Close frees memory allocated when Poppler opened the page
func (*Page) TextAttributes ¶
func (p *Page) TextAttributes() (results []TextAttributes)
func (*Page) TextLayout ¶
func (*Page) TextLayoutAndAttrs ¶
type TextAttributes ¶
type TextEl ¶
type TextEl struct {
Text string
Attrs *TextAttributes
Rect Rectangle
}
Source Files