cargolock

Documentation

Overview

Package cargolock extracts Cargo.lock files for rust projects

Index

• Constants
• func New() filesystem.Extractor
• type Extractor
  • func (e Extractor) Ecosystem(_ *extractor.Inventory) string
  • func (e Extractor) Extract(_ context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int

Constants

const (
	// Name is the unique name of this extractor.
	Name = "rust/cargolock"
)

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.lock files.

func (Extractor) Ecosystem

func (e Extractor) Ecosystem(_ *extractor.Inventory) string

Ecosystem returns the OSV ecosystem ('crates.io') of the software extracted by this extractor.

func (Extractor) Extract

func (e Extractor) Extract(_ context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)

Extract extracts packages from Cargo.lock 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 lockfile 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) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL

ToPURL converts an inventory created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor