redactor

Documentation

Index

• type RectangleProps
  • func RedactRectanglePropsNew() *RectangleProps
• type RedactionOptions
• type RedactionTerm
• type Redactor
  • func New(reader *_ab.PdfReader, opts *RedactionOptions, rectProps *RectangleProps) *Redactor
  • func (_bfga *Redactor) Redact() error
  • func (_cbd *Redactor) Write(writer _fa.Writer) error
  • func (_ceba *Redactor) WriteToFile(outputPath string) error

Types

type RectangleProps

type RectangleProps struct {
	FillColor   _dd.Color
	BorderWidth float64
	FillOpacity float64
}

RectangleProps defines properties of the redaction rectangle to be drawn.

func RedactRectanglePropsNew

func RedactRectanglePropsNew() *RectangleProps

RedactRectanglePropsNew return a new pointer to a default RectangleProps object.

type RedactionOptions

type RedactionOptions struct{ Terms []RedactionTerm }

RedactionOptions is a collection of RedactionTerm objects.

type RedactionTerm

type RedactionTerm struct{ Pattern *_f.Regexp }

RedactionTerm holds the regexp pattern and the replacement string for the redaction process.

type Redactor

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

Redactor represtents a Redactor object.

func New

func New(reader *_ab.PdfReader, opts *RedactionOptions, rectProps *RectangleProps) *Redactor

New instantiates a Redactor object with given PdfReader and `regex` pattern.

func (*Redactor) Redact

func (_bfga *Redactor) Redact() error

Redact executes the redact operation on a pdf file and updates the content streams of all pages of the file.

func (*Redactor) Write

func (_cbd *Redactor) Write(writer _fa.Writer) error

Write writes the content of `re.creator` to writer of type io.Writer interface.

func (*Redactor) WriteToFile

func (_ceba *Redactor) WriteToFile(outputPath string) error

WriteToFile writes the redacted document to file specified by `outputPath`.