document

package
v0.0.0-...-7fb09d6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2024 License: BSD-3-Clause Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExtractVariantFacts

func ExtractVariantFacts(ctx context.Context, o ExtractVariantFactsOptions) (_ *paperminer.Facts, err error)

ExtractVariantFacts downloads a particular document variant to a temporary directory before using an extraction function to get all facts. Among those, if any, the best are chosen and returned.

Types

type ExtractDocFactsFunc

type ExtractDocFactsFunc func(context.Context, *zap.Logger, *dossier.Document) (facter.FactsSlice, error)

type ExtractFactsOptions

type ExtractFactsOptions struct {
	Logger   *zap.Logger
	Variants []Variant
	Extract  ExtractVariantFactsFunc
}

type ExtractFileFactsFunc

type ExtractFileFactsFunc func(context.Context, *zap.Logger, string) (facter.FactsSlice, error)

func MakeFileFactsExtractor

func MakeFileFactsExtractor(extract ExtractDocFactsFunc, opts ...dossier.DocumentOption) ExtractFileFactsFunc

type ExtractVariantFactsFunc

type ExtractVariantFactsFunc func(context.Context, Variant) (*paperminer.Facts, error)

type ExtractVariantFactsOptions

type ExtractVariantFactsOptions struct {
	Logger *zap.Logger

	// Directory for storing temporary files. May be empty to use the system
	// default.
	Basedir string

	Client VariantFactsClient

	// Function extracting facts from a document file.
	Extract ExtractFileFactsFunc

	ID      int64
	Variant Variant
}

type Variant

type Variant int
const (
	Archived Variant = iota // archived
	Original                // original
)

func (Variant) String

func (i Variant) String() string

type VariantFactsClient

type VariantFactsClient interface {
	DownloadDocumentOriginal(context.Context, io.Writer, int64) (*plclient.DownloadResult, *plclient.Response, error)
	DownloadDocumentArchived(context.Context, io.Writer, int64) (*plclient.DownloadResult, *plclient.Response, error)
}

Jump to

Keyboard shortcuts

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