filesystem

Documentation

Index

• Variables
• type Decomposer
  • func New(funcs ...options.Function) (*Decomposer, error)
  • func (d *Decomposer) Extract(*api.DecomposerOptions) (*sbom.NodeList, error)
  • func (d *Decomposer) IndexFS(source fs.FS) (*sbom.NodeList, error)
• type FileProcessor
• type FileProcessorFactory

Variables

var FileProcessors = map[string]FileProcessorFactory{
	"hash": func() FileProcessor { return processors.NewHasher() },
}

FileProcessors is the list of available file processor factories. Each call produces a fresh instance to avoid shared mutable state.

Types

type Decomposer

type Decomposer struct {
	Options    options.Options
	Processors []FileProcessor
}

Decomposer is a filesystem indexer

func New

func New(funcs ...options.Function) (*Decomposer, error)

func (*Decomposer) Extract

func (d *Decomposer) Extract(*api.DecomposerOptions) (*sbom.NodeList, error)

Extract reads and hashes the files from the filesystem

func (*Decomposer) IndexFS

func (d *Decomposer) IndexFS(source fs.FS) (*sbom.NodeList, error)

IndexFS takes an fs.FS and returns a nodelist with all the files indexed and enriched by the configured processors.

type FileProcessor

type FileProcessor interface {
	Process(*options.Options, fs.FS, *sbom.Node) error
}

type FileProcessorFactory

type FileProcessorFactory func() FileProcessor

FileProcessorFactory is a function that creates a new FileProcessor instance.