pdf

package module

Go to main page

Versions in this module

v0

v0.5.0

May 17, 2024

Changes in this version

type Catalog

+ Metadata Reference

type WriterOptions

+ HumanReadable bool

v0.4.5

Mar 26, 2024

v0.4.4

Mar 7, 2024

v0.4.3

Mar 6, 2024

v0.4.2

Mar 3, 2024

v0.4.1

Mar 2, 2024

Changes in this version

type Rectangle

+ func (r *Rectangle) Dx() float64

+ func (r *Rectangle) Dy() float64

+ type Res struct

+ Data Object

+ DefName Name

+ func (r Res) DefaultName() Name

+ func (r Res) PDFObject() Object

type Resource

+ DefaultName func() Name

+ PDFObject func() Object

v0.4.0

Feb 4, 2024

Changes in this version

+ func IsMalformed(err error) bool

type Reference

+ func NewInternalReference(number uint32) Reference

+ func (x Reference) IsInternal() bool

v0.3.6

Sep 19, 2023

v0.3.5

Sep 8, 2023

Changes in this version

+ var GetBoolean = resolveAndCast[Boolean]

+ var GetInteger = resolveAndCast[Integer]

+ func DecodeStream(r Getter, x *Stream, numFilters int) (io.Reader, error)

+ func Wrap(err error, loc string) error

+ type Boolean bool

+ func (x Boolean) PDF(w io.Writer) error

type Dict

+ func GetDictTyped(r Getter, obj Object, tp Name) (Dict, error)

type Resource

+ Name Name

+ Ref Reference

+ func (r Resource) ResourceName() Name

type Resources

+ func (r *Resources) IsEmpty() bool

type Version

+ func GetVersion(pdf Putter) Version

v0.3.4

Jul 23, 2023

Changes in this version

+ func Format(obj Object) string

type Data

+ func NewData(v Version) *Data

v0.3.3

Jun 2, 2023

Changes in this version

+ func CheckVersion(pdf Putter, operation string, minVersion Version) error

+ func DecodeDict(r Getter, s interface{}, d Dict) error

+ func IsTagged(pdf Putter) bool

+ type Closer interface

+ Close func() error

+ Reference func() Reference

type Data

+ func (d *Data) Alloc() Reference

+ func (d *Data) AutoClose(res Closer)

+ func (d *Data) Close() error

+ func (d *Data) GetMeta() *MetaInfo

+ func (d *Data) OpenStream(ref Reference, dict Dict, filters ...Filter) (io.WriteCloser, error)

+ func (d *Data) WriteCompressed(refs []Reference, objects ...Object) error

+ type Filter interface

+ Decode func(Version, io.Reader) (io.Reader, error)

+ Encode func(Version, io.WriteCloser) (io.WriteCloser, error)

+ Info func(Version) (Name, Dict, error)

+ type FilterASCII85 struct

+ func (f FilterASCII85) Decode(_ Version, r io.Reader) (io.Reader, error)

+ func (f FilterASCII85) Encode(_ Version, w io.WriteCloser) (io.WriteCloser, error)

+ func (f FilterASCII85) Info(_ Version) (Name, Dict, error)

+ type FilterCompress Dict

+ func (f FilterCompress) Decode(v Version, r io.Reader) (io.Reader, error)

+ func (f FilterCompress) Encode(v Version, w io.WriteCloser) (io.WriteCloser, error)

+ func (f FilterCompress) Info(v Version) (Name, Dict, error)

+ type FilterFlate Dict

+ func (f FilterFlate) Decode(v Version, r io.Reader) (io.Reader, error)

+ func (f FilterFlate) Encode(v Version, w io.WriteCloser) (io.WriteCloser, error)

+ func (f FilterFlate) Info(v Version) (Name, Dict, error)

+ type FilterLZW Dict

+ func (f FilterLZW) Decode(v Version, r io.Reader) (io.Reader, error)

+ func (f FilterLZW) Encode(v Version, w io.WriteCloser) (io.WriteCloser, error)

+ func (f FilterLZW) Info(v Version) (Name, Dict, error)

type Getter

+ GetMeta func() *MetaInfo

+ type MetaInfo struct

+ Catalog *Catalog

+ ID [][]byte

+ Info *Info

+ Trailer Dict

+ Version Version

+ type PageDict struct

+ AA Object

+ AF Object

+ Annots Object

+ ArtBox Object

+ B Object

+ BleedBox Object

+ BoxColorInfo Object

+ Contents Object

+ CropBox Object

+ DPart Reference

+ Dur Number

+ Group Object

+ ID String

+ LastModified time.Time

+ MediaBox Object

+ Metadata Object

+ OutputIntents Object

+ PZ Number

+ Parent Reference

+ PieceInfo Object

+ PresSteps Object

+ Resources Object

+ Rotate PageRotation

+ SeparationInfo Object

+ StructParents Integer

+ Tabs Object

+ TemplateInstantiated Object

+ Thumb Object

+ Trans Object

+ TrimBox Object

+ UserUnit Number

+ VP Object

type Placeholder

+ func NewPlaceholder(pdf Putter, size int) *Placeholder

+ type Putter interface

+ Alloc func() Reference

+ AutoClose func(res Closer)

+ Close func() error

+ GetMeta func() *MetaInfo

+ OpenStream func(ref Reference, dict Dict, filters ...Filter) (io.WriteCloser, error)

+ Put func(ref Reference, obj Object) error

+ WriteCompressed func(refs []Reference, objects ...Object) error

type Reader

+ func (r *Reader) GetMeta() *MetaInfo

type Writer

+ func (pdf *Writer) GetMeta() *MetaInfo

v0.3.2

May 3, 2023

Changes in this version

type MalformedFileError

+ Loc []string

type Reader

+ Trailer Dict

v0.3.1

Apr 28, 2023

Changes in this version

+ const ErrorHandlingRecover

+ const ErrorHandlingReport

+ const ErrorHandlingStop

+ var GetArray = resolveAndCast[Array]

+ var GetBool = resolveAndCast[Bool]

+ var GetDict = resolveAndCast[Dict]

+ var GetInt = resolveAndCast[Integer]

+ var GetName = resolveAndCast[Name]

+ var GetReal = resolveAndCast[Real]

+ var GetStream = resolveAndCast[*Stream]

+ var GetString = resolveAndCast[String]

+ type Getter interface

+ Get func(Reference) (Object, error)

type Number

+ func GetNumber(r Getter, obj Object) (Number, error)

type Object

+ func Resolve(r Getter, obj Object) (Object, error)

type Reader

+ Errors []*MalformedFileError

+ Info *Info

+ func (r *Reader) Authenticate(perm Perm) error

+ type ReaderErrorHandling int

type ReaderOptions

+ ErrorHandling ReaderErrorHandling

type Rectangle

+ func GetRectangle(r Getter, obj Object) (*Rectangle, error)

type WriterOptions

+ UserPermissions Perm

v0.3.0

Apr 19, 2023

Changes in this version

+ type Data struct

+ Catalog *Catalog

+ ID [][]byte

+ Info *Info

+ Objects map[Reference]Object

+ Version Version

+ func Read(r io.ReadSeeker, opt *ReaderOptions) (*Data, error)

+ func (d *Data) Get(ref Reference) (Object, error)

+ func (d *Data) Put(ref Reference, obj Object) error

+ func (d *Data) Write(w io.Writer) error

type Reader

+ func (r *Reader) DecodeDict(s interface{}, d Dict) error

+ func (r *Reader) Get(ref Reference) (Object, error)

+ func (r *Reader) ReadInfo() (*Info, error)

type Writer

+ func (pdf *Writer) Put(ref Reference, obj Object) error

v0.2.0

Apr 11, 2023

Changes in this version

+ var ErrNoPDF = errors.New("PDF header not found")

+ type FileInfo struct

+ FileSize int64

+ HeaderVersion string

+ PDFEnd int64

+ PDFStart int64

+ R io.ReadSeeker

+ Sections []*FileSection

+ func SequentialScan(r io.ReadSeeker) (*FileInfo, error)

+ func (fi *FileInfo) MakeReader(opt *ReaderOptions) (*Reader, error)

+ func (fi *FileInfo) Read(objInfo *FileObject) (Object, error)

+ type FileObject struct

+ Broken bool

+ ObjEnd int64

+ ObjStart int64

+ SubType Name

+ Type string

+ type FileSection struct

+ Catalog *FileObject

+ EOFPos int64

+ ObjectStreams []*FileObject

+ Objects []*FileObject

+ StartXRefPos int64

+ TrailerPos int64

+ XRefPos int64

type Reader

+ func (r *Reader) DecodeStream(x *Stream, numFilters int) (io.Reader, error)

+ func (r *Reader) GetName(obj Object) (Name, error)

+ func (r *Reader) GetString(obj Object) (String, error)

+ type ReaderOptions struct

+ ReadPassword func(ID []byte, try int) string

type Reference

+ func NewReference(number uint32, generation uint16) Reference

type Resource

+ Close func() error

type Version

+ const V2_0

type Writer

+ Tagged bool

+ func (pdf *Writer) AutoClose(res Resource)

v0.1.0

Mar 1, 2023

Changes in this version

+ type Array []Object

+ func (x Array) AsRectangle() (*Rectangle, error)

+ func (x Array) PDF(w io.Writer) error

+ func (x Array) String() string

+ type AuthenticationError struct

+ ID []byte

+ func (err *AuthenticationError) Error() string

+ type Bool bool

+ func (x Bool) PDF(w io.Writer) error

+ type Catalog struct

+ AA Object

+ AcroForm Object

+ Collection Object

+ Dests Object

+ Extensions Object

+ Lang language.Tag

+ Legal Object

+ MarkInfo Object

+ MetaData *Reference

+ Names Object

+ NeedsRendering bool

+ OCProperties Object

+ OpenAction Object

+ Outlines *Reference

+ OutputIntents Object

+ PageLabels Object

+ PageLayout Name

+ PageMode Name

+ Pages *Reference

+ Perms Object

+ PieceInfo Object

+ Requirements Object

+ SpiderInfo Object

+ StructTreeRoot Object

+ Threads *Reference

+ URI Object

+ Version Version

+ ViewerPreferences Object

+ type Dict map[Name]Object

+ func AsDict(s interface{}) Dict

+ func (d Dict) Decode(s interface{}, get func(Object) (Object, error)) error

+ func (x Dict) PDF(w io.Writer) error

+ func (x Dict) String() string

+ type FilterInfo struct

+ Name Name

+ Parms Dict

+ type Info struct

+ Author string

+ CreationDate time.Time

+ Creator string

+ Custom map[string]string

+ Keywords string

+ ModDate time.Time

+ Producer string

+ Subject string

+ Title string

+ Trapped Name

+ type Integer int64

+ func (x Integer) PDF(w io.Writer) error

+ type MalformedFileError struct

+ Err error

+ Pos int64

+ func (err *MalformedFileError) Error() string

+ func (err *MalformedFileError) Unwrap() error

+ type Name string

+ func ParseName(buf []byte) (Name, error)

+ func (x Name) PDF(w io.Writer) error

+ type Number float64

+ func (x Number) PDF(w io.Writer) error

+ type Object interface

+ PDF func(w io.Writer) error

+ type PageRotation int

+ const Rotate0

+ const Rotate180

+ const Rotate270

+ const Rotate90

+ const RotateInherit

+ func DecodeRotation(rot Integer) (PageRotation, error)

+ func (r PageRotation) ToPDF() Integer

+ type Perm int

+ const PermAll

+ const PermAnnotate

+ const PermAssemble

+ const PermCopy

+ const PermForms

+ const PermModify

+ const PermPrint

+ const PermPrintDegraded

+ type Placeholder struct

+ func (x *Placeholder) PDF(w io.Writer) error

+ func (x *Placeholder) Set(val Object) error

+ type ReadPwdFunc func(ID []byte, try int) string

+ type Reader struct

+ Catalog *Catalog

+ ID [][]byte

+ Version Version

+ func NewReader(data io.ReaderAt, size int64, readPwd ReadPwdFunc) (*Reader, error)

+ func Open(fname string) (*Reader, error)

+ func (r *Reader) AuthenticateOwner() error

+ func (r *Reader) Close() error

+ func (r *Reader) GetArray(obj Object) (Array, error)

+ func (r *Reader) GetDict(obj Object) (Dict, error)

+ func (r *Reader) GetInfo() (*Info, error)

+ func (r *Reader) GetInt(obj Object) (Integer, error)

+ func (r *Reader) GetRectangle(obj Object) (*Rectangle, error)

+ func (r *Reader) GetStream(obj Object) (*Stream, error)

+ func (r *Reader) ReadSequential() (Object, *Reference, error)

+ func (r *Reader) Resolve(obj Object) (Object, error)

+ type Real float64

+ func (x Real) PDF(w io.Writer) error

+ type Rectangle struct

+ LLx float64

+ LLy float64

+ URx float64

+ URy float64

+ func (rect *Rectangle) Extend(other *Rectangle)

+ func (rect *Rectangle) NearlyEqual(other *Rectangle, eps float64) bool

+ func (rect *Rectangle) PDF(w io.Writer) error

+ func (rect *Rectangle) String() string

+ func (rect *Rectangle) XPos(rel float64) float64

+ func (rect *Rectangle) YPos(rel float64) float64

+ func (rect Rectangle) IsZero() bool

+ type Reference struct

+ Generation uint16

+ Number int

+ func (x *Reference) PDF(w io.Writer) error

+ func (x *Reference) String() string

+ type Resource interface

+ Reference func() *Reference

+ Write func(w *Writer) error

+ type Resources struct

+ ColorSpace Dict

+ ExtGState Dict

+ Font Dict

+ Pattern Dict

+ ProcSet Array

+ Properties Dict

+ Shading Dict

+ XObject Dict

+ type Stream struct

+ R io.Reader

+ func (x *Stream) Decode(resolve func(Object) (Object, error)) (io.Reader, error)

+ func (x *Stream) Filters(resolve func(Object) (Object, error)) ([]*FilterInfo, error)

+ func (x *Stream) PDF(w io.Writer) error

+ func (x *Stream) String() string

+ type String []byte

+ func Date(t time.Time) String

+ func ParseString(buf []byte) (String, error)

+ func TextString(s string) String

+ func (x String) AsDate() (time.Time, error)

+ func (x String) AsTextString() string

+ func (x String) PDF(w io.Writer) error

+ type Version int

+ const V1_0

+ const V1_1

+ const V1_2

+ const V1_3

+ const V1_4

+ const V1_5

+ const V1_6

+ const V1_7

+ func ParseVersion(verString string) (Version, error)

+ func (ver Version) String() string

+ func (ver Version) ToString() (string, error)

+ type VersionError struct

+ Earliest Version

+ Operation string

+ func (err *VersionError) Error() string

+ type Writer struct

+ Catalog *Catalog

+ Resources map[interface{}]Resource

+ Version Version

+ func Create(name string) (*Writer, error)

+ func NewWriter(w io.Writer, opt *WriterOptions) (*Writer, error)

+ func (pdf *Writer) Alloc() *Reference

+ func (pdf *Writer) CheckVersion(operation string, minVersion Version) error

+ func (pdf *Writer) Close() error

+ func (pdf *Writer) NewPlaceholder(size int) *Placeholder

+ func (pdf *Writer) OnClose(callback func(*Writer) error)

+ func (pdf *Writer) OpenStream(dict Dict, ref *Reference, filters ...*FilterInfo) (io.WriteCloser, *Reference, error)

+ func (pdf *Writer) SetInfo(info *Info)

+ func (pdf *Writer) Write(obj Object, ref *Reference) (*Reference, error)

+ func (pdf *Writer) WriteCompressed(refs []*Reference, objects ...Object) ([]*Reference, error)

+ type WriterOptions struct

+ ID [][]byte

+ OwnerPassword string

+ UserPassword string

+ UserPermission Perm

+ Version Version

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