rpm

Documentation

Overview

Package rpm implements an annotator for language packages that have already been found in RPM OS packages.

Index

• Constants
• func NewDefault() annotator.Annotator
• type Annotator
  • func New(cfg Config) *Annotator
  • func (a *Annotator) Annotate(ctx context.Context, input *annotator.ScanInput, results *inventory.Inventory) error
  • func (Annotator) Name() string
  • func (Annotator) Requirements() *plugin.Capabilities
  • func (Annotator) Version() int
• type Config
  • func DefaultConfig() Config

Constants

const (
	// Name of the Annotator.
	Name = "vex/os-duplicate/rpm"
)

Functions

func NewDefault

func NewDefault() annotator.Annotator

NewDefault returns the Annotator with the default config settings.

Types

type Annotator

type Annotator struct {
	Timeout time.Duration
}

Annotator adds annotations to language packages that have already been found in RPM OS packages.

func New

func New(cfg Config) *Annotator

New returns a new Annotator.

For most use cases, initialize with: ``` a := New(DefaultConfig()) ```

func (*Annotator) Annotate

func (a *Annotator) Annotate(ctx context.Context, input *annotator.ScanInput, results *inventory.Inventory) error

Annotate adds annotations to language packages that have already been found in RPM OS packages.

func (Annotator) Name

func (Annotator) Name() string

Name of the annotator.

func (Annotator) Requirements

func (Annotator) Requirements() *plugin.Capabilities

Requirements of the annotator.

func (Annotator) Version

func (Annotator) Version() int

Version of the annotator.

type Config

type Config struct {
	// Timeout is the timeout duration for parsing the RPM database.
	Timeout time.Duration
}

Config contains RPM specific configuration values

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration values for the Annotator.