tools

package
v4.3.5 Latest Latest
Warning

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

Go to latest
Published: Sep 2, 2021 License: BSD-3-Clause Imports: 38 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AppendCommonConfigFlags

func AppendCommonConfigFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendCommonInstructionsFlags

func AppendCommonInstructionsFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendCommonProcessToolFlags

func AppendCommonProcessToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendCommonServerToolFlags

func AppendCommonServerToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendCommonTileSeedToolFlags

func AppendCommonTileSeedToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendCommonToolModeFlags

func AppendCommonToolModeFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendCommonTransformToolFlags

func AppendCommonTransformToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendProcessToolFlags

func AppendProcessToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendServerToolFlags

func AppendServerToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendTileSeedToolFlags

func AppendTileSeedToolFlags(ctx context.Context, fs *flag.FlagSet) error

func AppendTransformToolFlags

func AppendTransformToolFlags(ctx context.Context, fs *flag.FlagSet) error

func NewToolRunnerThrottle

func NewToolRunnerThrottle() (chan bool, error)

func ProcessMany

func ProcessMany(ctx context.Context, opts *ProcessOptions, uris ...iiifuri.URI) error

func ProcessToolFlagSet

func ProcessToolFlagSet(ctx context.Context) (*flag.FlagSet, error)

func ServerToolFlagSet

func ServerToolFlagSet(ctx context.Context) (*flag.FlagSet, error)

func TileSeedToolFlagSet

func TileSeedToolFlagSet(ctx context.Context) (*flag.FlagSet, error)

func Transform

func Transform(ctx context.Context, opts *TransformOptions, uri iiifuri.URI) error

func TransformMany

func TransformMany(ctx context.Context, opts *TransformOptions, uris ...iiifuri.URI) error

func TransformToolFlagSet

func TransformToolFlagSet(ctx context.Context) (*flag.FlagSet, error)

Types

type Event added in v4.2.0

type Event struct {
	Records []Record
}

Event incoming event

func (*Event) UnmarshalJSON added in v4.2.0

func (event *Event) UnmarshalJSON(data []byte) error

type IIIFServerTool

type IIIFServerTool struct {
	Tool
}

func (*IIIFServerTool) Run

func (t *IIIFServerTool) Run(ctx context.Context) error

func (*IIIFServerTool) RunWithFlagSet

func (t *IIIFServerTool) RunWithFlagSet(ctx context.Context, fs *flag.FlagSet) error

func (*IIIFServerTool) RunWithFlagSetAndPaths

func (t *IIIFServerTool) RunWithFlagSetAndPaths(ctx context.Context, fs *flag.FlagSet, paths ...string) error

type ProcessOptions

type ProcessOptions struct {
	Config         *config.Config
	Driver         iiifdriver.Driver
	Processor      process.Processor
	Instructions   process.IIIFInstructionSet
	Report         bool
	ReportTemplate string
	ReportBucket   *blob.Bucket
}

type ProcessResultsReport

type ProcessResultsReport map[string]interface{}

func ProcessManyWithReport

func ProcessManyWithReport(ctx context.Context, opts *ProcessOptions, uris ...iiifuri.URI) (*ProcessResultsReport, error)

type ProcessTool

type ProcessTool struct {
	Tool
	URIFunc URIFunc
}

func (*ProcessTool) Run

func (t *ProcessTool) Run(ctx context.Context) error

func (*ProcessTool) RunWithFlagSet

func (t *ProcessTool) RunWithFlagSet(ctx context.Context, fs *flag.FlagSet) error

func (*ProcessTool) RunWithFlagSetAndPaths

func (t *ProcessTool) RunWithFlagSetAndPaths(ctx context.Context, fs *flag.FlagSet, paths ...string) error

type Record added in v4.2.0

type Record struct {
	EventSource    string
	EventSourceArn string
	AWSRegion      string
	S3             aws_events.S3Entity
	SQS            aws_events.SQSMessage
	SNS            aws_events.SNSEntity
}

type Seed

type Seed struct {
	Source string
	Target string
}

func SeedFromString

func SeedFromString(str_uri string, no_extension bool) (*Seed, error)

func SeedFromURI

func SeedFromURI(u iiifuri.URI, no_extension bool) (*Seed, error)

type TileSeedOnCompleteFunc

type TileSeedOnCompleteFunc func(*iiifconfig.Config, string, string, int, error)

type TileSeedTool

type TileSeedTool struct {
	Tool
	// contains filtered or unexported fields
}

func (*TileSeedTool) Run

func (t *TileSeedTool) Run(ctx context.Context) error

func (*TileSeedTool) RunWithFlagSet

func (t *TileSeedTool) RunWithFlagSet(ctx context.Context, fs *flag.FlagSet) error

func (*TileSeedTool) RunWithFlagSetAndPaths

func (t *TileSeedTool) RunWithFlagSetAndPaths(ctx context.Context, fs *flag.FlagSet, paths ...string) error

type TileSeedToolOptions

type TileSeedToolOptions struct {
	URIFunc        URIFunc
	OnCompleteFunc TileSeedOnCompleteFunc
}

type Tool

type Tool interface {
	Run(context.Context) error
	RunWithFlagSet(context.Context, *flag.FlagSet) error
	RunWithFlagSetAndPaths(context.Context, *flag.FlagSet, ...string) error
}

func NewIIIFServerTool

func NewIIIFServerTool() (Tool, error)

func NewProcessTool

func NewProcessTool() (Tool, error)

func NewProcessToolWithURIFunc

func NewProcessToolWithURIFunc(uri_func URIFunc) (Tool, error)

func NewSynchronousToolRunner

func NewSynchronousToolRunner(tools ...Tool) (Tool, error)

func NewTileSeedTool

func NewTileSeedTool() (Tool, error)

func NewTileSeedToolWithOptions

func NewTileSeedToolWithOptions(opts *TileSeedToolOptions) (Tool, error)

func NewTileSeedToolWithURIFunc

func NewTileSeedToolWithURIFunc(uri_func URIFunc) (Tool, error)

func NewToolRunner

func NewToolRunner(tools ...Tool) (Tool, error)

func NewToolRunnerWithOptions

func NewToolRunnerWithOptions(opts *ToolRunnerOptions) (Tool, error)

func NewTransformTool

func NewTransformTool() (Tool, error)

type ToolRunner

type ToolRunner struct {
	Tool
	// contains filtered or unexported fields
}

func (*ToolRunner) Run

func (t *ToolRunner) Run(ctx context.Context) error

func (*ToolRunner) RunWithFlagSet

func (t *ToolRunner) RunWithFlagSet(ctx context.Context, fs *flag.FlagSet) error

func (*ToolRunner) RunWithFlagSetAndPaths

func (t *ToolRunner) RunWithFlagSetAndPaths(ctx context.Context, fs *flag.FlagSet, paths ...string) error

type ToolRunnerOnCompleteFunc

type ToolRunnerOnCompleteFunc func(context.Context, string) error

type ToolRunnerOptions

type ToolRunnerOptions struct {
	Tools          []Tool
	Throttle       chan bool
	OnCompleteFunc ToolRunnerOnCompleteFunc
}

type TransformOptions

type TransformOptions struct {
	Config         *iiifconfig.Config
	Driver         iiifdriver.Driver
	Transformation *iiifimage.Transformation
	SourceBucket   *blob.Bucket
	TargetBucket   *blob.Bucket
}

type TransformTool

type TransformTool struct {
	Tool
}

func (*TransformTool) Run

func (t *TransformTool) Run(ctx context.Context) error

func (*TransformTool) RunWithFlagSet

func (t *TransformTool) RunWithFlagSet(ctx context.Context, fs *flag.FlagSet) error

func (*TransformTool) RunWithFlagSetAndPaths

func (t *TransformTool) RunWithFlagSetAndPaths(ctx context.Context, fs *flag.FlagSet, paths ...string) error

type URIFunc

type URIFunc func(string) (iiifuri.URI, error)

func DefaultURIFunc

func DefaultURIFunc() URIFunc

Jump to

Keyboard shortcuts

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