standalone

Documentation

Overview

Package standalone provides a way to extract in a standalone mode (e.g. a command).

Index

• func Run(ctx context.Context, config *Config) ([]*extractor.Inventory, []*plugin.Status, error)
• type Config
• type Extractor
• type ScanInput

Functions

func Run

func Run(ctx context.Context, config *Config) ([]*extractor.Inventory, []*plugin.Status, error)

Run the extractors that are specified in the config.

Types

type Config

type Config struct {
	Extractors []Extractor
	ScanRoot   *scalibrfs.ScanRoot
}

Config for running standalone extractors.

type Extractor

type Extractor interface {
	extractor.Extractor
	// Extract the information.
	Extract(ctx context.Context, input *ScanInput) ([]*extractor.Inventory, error)
}

Extractor is an interface for plugins that extract information independently. For example, a plugin that executes a command or retrieves information from only one file.

type ScanInput

type ScanInput struct {
	// FS for file access. This is rooted at Root.
	FS scalibrfs.FS
	// The root directory to start the extraction from.
	Root string
}

ScanInput provides information for the extractor about the scan.