Copyright 2019 The Go Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

package internal

import (
	
)
UnitMeta represents metadata about a unit.
Unit level information 
	Path              string
	Name              string
	IsRedistributable bool
	Licenses          []*licenses.Metadata
Module level information Note: IsRedistributable (above) applies to the unit; ModuleInfo.IsRedistributable applies to the module.
	ModuleInfo
}
IsPackage reports whether the path represents a package path.
func ( *UnitMeta) () bool {
	return .Name != ""
}
IsCommand reports whether the path represents a package path.
func ( *UnitMeta) () bool {
	return .IsPackage() && .Name == "main"
}
IsModule reports whether the path represents a module path.
func ( *UnitMeta) () bool {
	return .ModulePath == .Path
}
Unit represents the contents of some path in the Go package/module namespace. It might be a module, a package, both a module and a package, or none of the above: a directory within a module that has no .go files, but contains other units, licenses and/or READMEs."
type Unit struct {
	UnitMeta
	Readme          *Readme
	BuildContexts   []BuildContext   // set only on read
	Documentation   []*Documentation // at most one on read
	Subdirectories  []*PackageMeta
	Imports         []string
	LicenseContents []*licenses.License
	Symbols         map[BuildContext][]*Symbol
	NumImports      int
	NumImportedBy   int
SymbolHistory is a map of symbolName to the version when the symbol was first added to the package.
	SymbolHistory map[string]string
}
Documentation is the rendered documentation for a given package for a specific GOOS and GOARCH.
The values of the GOOS and GOARCH environment variables used to parse the package.
	GOOS     string
	GOARCH   string
	Synopsis string
	Source   []byte // encoded ast.Files; see godoc.Package.Encode
	API      []*Symbol
}
Readme is a README at the specified filepath.
type Readme struct {
	Filepath string
	Contents string
}
PackageMeta represents the metadata of a package in a module version.
type PackageMeta struct {
	Path              string
	Name              string
	Synopsis          string
	IsRedistributable bool
	Licenses          []*licenses.Metadata // metadata of applicable licenses
}
A FieldSet is a bit set of struct fields. It is used to avoid reading large struct fields from the data store. FieldSet is also the type of the individual bit values. (Think of them as singleton sets.) MinimalFields (the zero value) is the empty set. AllFields is the set containing every field. FieldSet bits are unique across the entire project, because some types are concatenations (via embedding) of others. For example, a
type FieldSet int64
MinimalFields is the empty FieldSet.
const MinimalFields FieldSet = 0
AllFields is the FieldSet that contains all fields.
const AllFields FieldSet = -1
StringFieldMissing is the value for string fields that are not present in a struct. We use it to distinguish a (possibly valid) empty string from a field that was never populated.
const StringFieldMissing = "!MISSING"
FieldSet bits for fields that can be conditionally read from the data store.
const (
	WithMain FieldSet = 1 << iota
	WithImports
	WithLicenses