Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

modload

package

Go to main page

Versions in this module

v1

v1.22.2

Apr 24, 2024

v1.22.1

Apr 24, 2024

Changes in this version

type MainModuleSet

+ func (mms *MainModuleSet) WorkFile() *modfile.WorkFile

v1.21.6

Jan 9, 2024

v1.21.3

Jan 6, 2024

v1.21.2

Jan 6, 2024

v1.21.0

Dec 26, 2023

Changes in this version

+ var ErrDisallowed = errors.New("disallowed module version")

+ var ErrNoModRoot = errors.New(...)

+ var ExplicitWriteGoMod bool

+ var ForceUseModules bool

+ var HelpGoMod = &base.Command

+ var HelpModules = &base.Command

+ var RootMode Root

+ func AllowMissingModuleImports()

+ func BinDir() string

+ func CheckAllowed(ctx context.Context, m module.Version) error

+ func CheckDeprecation(ctx context.Context, m module.Version) (deprecation string, err error)

+ func CheckExclusions(ctx context.Context, m module.Version) error

+ func CheckRetractions(ctx context.Context, m module.Version) (err error)

+ func CreateModFile(ctx context.Context, modPath string)

+ func EditBuildList(ctx context.Context, add, mustSelect []module.Version) (changed bool, err error)

+ func Enabled() bool

+ func EnterModule(ctx context.Context, enterModroot string)

+ func FindGoMod(wd string) string

+ func FindGoWork(wd string) string

+ func HasModRoot() bool

+ func ImportFromFiles(ctx context.Context, gofiles []string)

+ func Init()

+ func InitWorkfile()

+ func IsRevisionQuery(path, vers string) bool

+ func ListModules(ctx context.Context, args []string, mode ListMode, reuseFile string) ([]*modinfo.ModulePublic, error)

+ func LoadPackages(ctx context.Context, opts PackageOpts, patterns ...string) (matches []*search.Match, loadedPackages []string)

+ func Lookup(parentPath string, parentIsStd bool, path string) (dir, realPath string, err error)

+ func MatchInModule(ctx context.Context, pattern string, m module.Version, tags map[string]bool) *search.Match

+ func ModFile() *modfile.File

+ func ModFilePath() string

+ func ModInfoData(info string) []byte

+ func ModInfoProg(info string, isgccgo bool) []byte

+ func ModuleInfo(ctx context.Context, path string) *modinfo.ModulePublic

+ func MustHaveModRoot()

+ func OverrideRoots(ctx context.Context, replace []module.Version)

+ func PackageModRoot(ctx context.Context, pkgpath string) string

+ func PackageModule(path string) module.Version

+ func PackageModuleInfo(ctx context.Context, pkgpath string) *modinfo.ModulePublic

+ func Query(ctx context.Context, path, query, current string, allowed AllowedFunc) (*modfetch.RevInfo, error)

+ func QueryPattern(ctx context.Context, pattern, query string, current func(string) string, ...) (pkgMods []QueryResult, modOnly *QueryResult, err error)

+ func ReadModFile(gomod string, fix modfile.VersionFixer) (data []byte, f *modfile.File, err error)

+ func ReadWorkFile(path string) (*modfile.WorkFile, error)

+ func Replacement(mod module.Version) module.Version

+ func Reset()

+ func ShortMessage(message, emptyDefault string) string

+ func ToDirectoryPath(path string) string

+ func UpdateWorkFile(wf *modfile.WorkFile)

+ func UpdateWorkGoVersion(wf *modfile.WorkFile, goVers string) (changed bool)

+ func VendorDir() string

+ func Why(path string) string

+ func WhyDepth(path string) int

+ func WillBeEnabled() bool

+ func WorkFilePath() string

+ func WriteGoMod(ctx context.Context, opts WriteOpts) error

+ func WriteWorkFile(path string, wf *modfile.WorkFile) error

+ type AllowedFunc func(context.Context, module.Version) error

+ type AmbiguousImportError struct

+ Dirs []string

+ Modules []module.Version

+ func (e *AmbiguousImportError) Error() string

+ func (e *AmbiguousImportError) ImportPath() string

+ type Conflict struct

+ Constraint module.Version

+ Err error

+ Path []module.Version

+ func (c Conflict) String() string

+ func (c Conflict) Summary() string

+ func (c Conflict) UnwrapModuleError() error

+ type ConstraintError struct

+ Conflicts []Conflict

+ func (e *ConstraintError) Error() string

+ type DirectImportFromImplicitDependencyError struct

+ ImportedPath string

+ ImporterPath string

+ Module module.Version

+ func (e *DirectImportFromImplicitDependencyError) Error() string

+ func (e *DirectImportFromImplicitDependencyError) ImportPath() string

+ type ImportMissingError struct

+ ImportingMainModule module.Version

+ Module module.Version

+ Path string

+ QueryErr error

+ func (e *ImportMissingError) Error() string

+ func (e *ImportMissingError) ImportPath() string

+ func (e *ImportMissingError) Unwrap() error

+ type ImportMissingSumError struct

+ func (e *ImportMissingSumError) Error() string

+ func (e *ImportMissingSumError) ImportPath() string

+ type ListMode int

+ const ListDeprecated

+ const ListRetracted

+ const ListRetractedVersions

+ const ListU

+ const ListVersions

+ type MainModuleSet struct

+ var MainModules *MainModuleSet

+ func (mms *MainModuleSet) Contains(path string) bool

+ func (mms *MainModuleSet) DirImportPath(ctx context.Context, dir string) (path string, m module.Version)

+ func (mms *MainModuleSet) GetSingleIndexOrNil() *modFileIndex

+ func (mms *MainModuleSet) GoVersion() string

+ func (mms *MainModuleSet) HighestReplaced() map[string]string

+ func (mms *MainModuleSet) InGorootSrc(m module.Version) bool

+ func (mms *MainModuleSet) Index(m module.Version) *modFileIndex

+ func (mms *MainModuleSet) Len() int

+ func (mms *MainModuleSet) ModContainingCWD() module.Version

+ func (mms *MainModuleSet) ModFile(m module.Version) *modfile.File

+ func (mms *MainModuleSet) ModRoot(m module.Version) string

+ func (mms *MainModuleSet) PathPrefix(m module.Version) string

+ func (mms *MainModuleSet) SetIndex(m module.Version, index *modFileIndex)

+ func (mms *MainModuleSet) Toolchain() string

+ func (mms *MainModuleSet) Versions() []module.Version

+ func (mms *MainModuleSet) WorkFileReplaceMap() map[module.Version]module.Version

+ type ModuleGraph struct

+ func LoadModGraph(ctx context.Context, goVersion string) (*ModuleGraph, error)

+ func (mg *ModuleGraph) BuildList() []module.Version

+ func (mg *ModuleGraph) RequiredBy(m module.Version) (reqs []module.Version, ok bool)

+ func (mg *ModuleGraph) Selected(path string) (version string)

+ func (mg *ModuleGraph) WalkBreadthFirst(f func(m module.Version))

+ type ModuleRetractedError struct

+ Rationale []string

+ func (e *ModuleRetractedError) Error() string

+ func (e *ModuleRetractedError) Is(err error) bool

+ type NoMatchingVersionError struct

+ func (e *NoMatchingVersionError) Error() string

+ type NoPatchBaseError struct

+ func (e *NoPatchBaseError) Error() string

+ type PackageNotInModuleError struct

+ MainModules []module.Version

+ Mod module.Version

+ Pattern string

+ Query string

+ Replacement module.Version

+ func (e *PackageNotInModuleError) Error() string

+ func (e *PackageNotInModuleError) ImportPath() string

+ type PackageOpts struct

+ AllowErrors bool

+ AllowPackage func(ctx context.Context, path string, mod module.Version) error

+ AssumeRootsImported bool

+ LoadTests bool

+ MainModule module.Version

+ ResolveMissingImports bool

+ SilenceMissingStdImports bool

+ SilenceNoGoErrors bool

+ SilencePackageErrors bool

+ SilenceUnmatchedWarnings bool

+ Switcher gover.Switcher

+ Tags map[string]bool

+ Tidy bool

+ TidyCompatibleVersion string

+ TidyGoVersion string

+ UseVendorAll bool

+ VendorModulesInGOROOTSrc bool

+ type QueryMatchesMainModulesError struct

+ MainModules []module.Version

+ Pattern string

+ Query string

+ func (e *QueryMatchesMainModulesError) Error() string

+ type QueryMatchesPackagesInMainModuleError struct

+ Packages []string

+ Pattern string

+ Query string

+ func (e *QueryMatchesPackagesInMainModuleError) Error() string

+ type QueryResult struct

+ Mod module.Version

+ Packages []string

+ Rev *modfetch.RevInfo

+ func QueryPackages(ctx context.Context, pattern, query string, current func(string) string, ...) ([]QueryResult, error)

+ type QueryUpgradesAllError struct

+ MainModules []module.Version

+ Query string

+ func (e *QueryUpgradesAllError) Error() string

+ type Requirements struct

+ func LoadModFile(ctx context.Context) *Requirements

+ func (rs *Requirements) GoVersion() string

+ func (rs *Requirements) Graph(ctx context.Context) (*ModuleGraph, error)

+ func (rs *Requirements) IsDirect(path string) bool

+ func (rs *Requirements) String() string

+ type Root int

+ const AutoRoot

+ const NeedRoot

+ const NoRoot

+ type WildcardInFirstElementError struct

+ Pattern string

+ Query string

+ func (e *WildcardInFirstElementError) Error() string

+ type WriteOpts struct

+ DropToolchain bool

+ ExplicitToolchain bool

+ TidyWroteGo bool