cargotoml

Documentation

Overview

Package cargotoml extracts Cargo.toml files for rust projects

Index

• Constants
• func New() filesystem.Extractor
• 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 name of the Extractor.
	Name = "rust/cargotoml"
)

Functions

func New

func New() filesystem.Extractor

New returns a new instance of the extractor.

Types

type Extractor

type Extractor struct{}

Extractor extracts crates.io packages from Cargo.toml files.

func (Extractor) Extract

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

Extract extracts packages from Cargo.toml files passed through the scan input.

func (Extractor) FileRequired

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

FileRequired returns true if the specified file matches Cargo toml file patterns.

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