model

Documentation

Index

• type BuildInfo
• type License
• type Module
• type ModuleReference
  • func (r ModuleReference) IsLocal() bool
  • func (r ModuleReference) String() string

Types

type BuildInfo

type BuildInfo struct {
	Path        string            // OS level absolute path to the binary this build info relates to
	PackagePath string            // package path indicated by the build info, e.g. github.com/foo/bar/cmd/baz
	ModulePath  string            // module path indicated by the build info, e.g. github.com/foo/bar
	ModuleRefs  []ModuleReference // all modules that feature in the build info output
}

BuildInfo encapsulates build info embedded into a Go compile binary

type License

type License struct {
	Path       string  // OS level absolute path to the license file
	Content    string  // the exact contents of the license file
	Name       string  // SPDX name of the license
	Confidence float64 // confidence from license classification
}

License carries license classification details

type Module

type Module struct {
	ModuleReference           // reference (path & version)
	Dir             string    // OS level absolute path to where the cached copy of the module is located
	Licenses        []License // resolved licenses
}

Module carries details of a Go module

type ModuleReference

type ModuleReference struct {
	Path    string // module path, e.g. github.com/foo/bar
	Version string // module version (can take a variety of forms)
}

ModuleReference is a reference to a particular version of a named module

func (ModuleReference) IsLocal

func (r ModuleReference) IsLocal() bool

IsLocal returns true if the module reference points to a local path

func (ModuleReference) String

func (r ModuleReference) String() string

String returns a typical string representation of a module reference (path@version)