opam

Documentation

Overview

Package opam extracts OCaml packages from opam install files.

Index

• Constants
• func New(_ *cpb.PluginConfig) (filesystem.Extractor, error)
• func ParseInstall(ctx context.Context, r io.Reader) ([]*extractor.Package, error)
• type Extractor
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) Version() int

Constants

const (
	// Name is the unique name of this extractor.
	Name = "ocaml/opam"
)

Functions

func New

func New(_ *cpb.PluginConfig) (filesystem.Extractor, error)

New returns a new instance of the extractor.

func ParseInstall

func ParseInstall(ctx context.Context, r io.Reader) ([]*extractor.Package, error)

ParseInstall parses an opam install file or opam list output.

Types

type Extractor

type Extractor struct{}

Extractor extracts OCaml packages from opam install files.

func (Extractor) Extract

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)

Extract extracts packages from the opam install file.

func (Extractor) FileRequired

func (e Extractor) FileRequired(api filesystem.FileAPI) bool

FileRequired returns true if the file path matches opam install files.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.