Go: cmd/go/internal/modfetch Index | Files | Directories

package modfetch

import "cmd/go/internal/modfetch"


Package Files

cache.go coderepo.go fetch.go insecure.go key.go proxy.go pseudo.go repo.go sumdb.go


var GoSumFile string // path to go.sum; set by package modload
var HelpGoproxy = &base.Command{
    UsageLine: "goproxy",
    Short:     "module proxy protocol",
    Long:      "" /* 3025 byte string literal not displayed */,
var HelpModuleAuth = &base.Command{
    UsageLine: "module-auth",
    Short:     "module authentication using go.sum",
    Long:      "" /* 4266 byte string literal not displayed */,
var HelpModulePrivate = &base.Command{
    UsageLine: "module-private",
    Short:     "module configuration for non-public modules",
    Long:      "" /* 1905 byte string literal not displayed */,

func CachePath Uses

func CachePath(m module.Version, suffix string) (string, error)

func Download Uses

func Download(mod module.Version) (dir string, err error)

Download downloads the specific module version to the local download cache and returns the name of the directory corresponding to the root of the module's file tree.

func DownloadDir Uses

func DownloadDir(m module.Version) (string, error)

DownloadDir returns the directory to which m should have been downloaded. An error will be returned if the module path or version cannot be escaped. An error satisfying errors.Is(err, os.ErrNotExist) will be returned along with the directory if the directory does not exist or if the directory is not completely populated.

func DownloadZip Uses

func DownloadZip(mod module.Version) (zipfile string, err error)

DownloadZip downloads the specific module version to the local zip cache and returns the name of the zip file.

func GoMod Uses

func GoMod(path, rev string) ([]byte, error)

GoMod is like Lookup(path).GoMod(rev) but avoids the repository path resolution in Lookup if the result is already cached on local disk.

func GoModFile Uses

func GoModFile(path, version string) (string, error)

GoModFile is like GoMod but returns the name of the file containing the cached information.

func GoModSum Uses

func GoModSum(path, version string) (string, error)

GoModSum returns the go.sum entry for the module version's go.mod file. (That is, it returns the entry listed in go.sum as "path version/go.mod".)

func ImportRepoRev Uses

func ImportRepoRev(path, rev string) (Repo, *RevInfo, error)

ImportRepoRev returns the module and version to use to access the given import path loaded from the source code repository that the original "go get" would have used, at the specific repository revision (typically a commit hash, but possibly also a source control tag).

func InfoFile Uses

func InfoFile(path, version string) (string, error)

InfoFile is like Stat but returns the name of the file containing the cached information.

func IsPseudoVersion Uses

func IsPseudoVersion(v string) bool

IsPseudoVersion reports whether v is a pseudo-version.

func PseudoVersion Uses

func PseudoVersion(major, older string, t time.Time, rev string) string

PseudoVersion returns a pseudo-version for the given major version ("v1") preexisting older tagged version ("" or "v1.2.3" or "v1.2.3-pre"), revision time, and revision identifier (usually a 12-byte commit hash prefix).

func PseudoVersionBase Uses

func PseudoVersionBase(v string) (string, error)

PseudoVersionBase returns the canonical parent version, if any, upon which the pseudo-version v is based.

If v has no parent version (that is, if it is "vX.0.0-[…]"), PseudoVersionBase returns the empty string and a nil error.

func PseudoVersionRev Uses

func PseudoVersionRev(v string) (rev string, err error)

PseudoVersionRev returns the revision identifier of the pseudo-version v. It returns an error if v is not a pseudo-version.

func PseudoVersionTime Uses

func PseudoVersionTime(v string) (time.Time, error)

PseudoVersionTime returns the time stamp of the pseudo-version v. It returns an error if v is not a pseudo-version or if the time stamp embedded in the pseudo-version is not a valid time.

func RemoveAll Uses

func RemoveAll(dir string) error

RemoveAll removes a directory written by Download or Unzip, first applying any permission changes needed to do so.

func SideLock Uses

func SideLock() (unlock func(), err error)

SideLock locks a file within the module cache that that previously guarded edits to files outside the cache, such as go.sum and go.mod files in the user's working directory. If err is nil, the caller MUST eventually call the unlock function.

func SortVersions Uses

func SortVersions(list []string)

func Sum Uses

func Sum(mod module.Version) string

Sum returns the checksum for the downloaded copy of the given module, if present in the download cache.

func TrimGoSum Uses

func TrimGoSum(keep map[module.Version]bool)

TrimGoSum trims go.sum to contain only the modules for which keep[m] is true.

func TryProxies Uses

func TryProxies(f func(proxy string) error) error

TryProxies iterates f over each configured proxy (including "noproxy" and "direct" if applicable) until f returns no error or until f returns an error that is not equivalent to os.ErrNotExist on a proxy configured not to fall back on errors.

TryProxies then returns that final error.

If GOPROXY is set to "off", TryProxies invokes f once with the argument "off".

func WriteGoSum Uses

func WriteGoSum()

WriteGoSum writes the go.sum file if it needs to be updated.

type DownloadDirPartialError Uses

type DownloadDirPartialError struct {
    Dir string
    Err error

DownloadDirPartialError is returned by DownloadDir if a module directory exists but was not completely populated.

DownloadDirPartialError is equivalent to os.ErrNotExist.

func (*DownloadDirPartialError) Error Uses

func (e *DownloadDirPartialError) Error() string

func (*DownloadDirPartialError) Is Uses

func (e *DownloadDirPartialError) Is(err error) bool

type Repo Uses

type Repo interface {
    // ModulePath returns the module path.
    ModulePath() string

    // Versions lists all known versions with the given prefix.
    // Pseudo-versions are not included.
    // Versions should be returned sorted in semver order
    // (implementations can use SortVersions).
    Versions(prefix string) ([]string, error)

    // Stat returns information about the revision rev.
    // A revision can be any identifier known to the underlying service:
    // commit hash, branch, tag, and so on.
    Stat(rev string) (*RevInfo, error)

    // Latest returns the latest revision on the default branch,
    // whatever that means in the underlying source code repository.
    // It is only used when there are no tagged versions.
    Latest() (*RevInfo, error)

    // GoMod returns the go.mod file for the given version.
    GoMod(version string) (data []byte, err error)

    // Zip writes a zip file for the given version to dst.
    Zip(dst io.Writer, version string) error

A Repo represents a repository storing all versions of a single module. It must be safe for simultaneous use by multiple goroutines.

func Lookup Uses

func Lookup(proxy, path string) (Repo, error)

Lookup returns the module with the given module path, fetched through the given proxy.

The distinguished proxy "direct" indicates that the path should be fetched from its origin, and "noproxy" indicates that the patch should be fetched directly only if GONOPROXY matches the given path.

For the distinguished proxy "off", Lookup always returns a non-nil error.

A successful return does not guarantee that the module has any defined versions.

type RevInfo Uses

type RevInfo struct {
    Version string    // suggested version string for this revision
    Time    time.Time // commit time

    // These fields are used for Stat of arbitrary rev,
    // but they are not recorded when talking about module versions.
    Name  string `json:"-"` // complete ID in underlying repository
    Short string `json:"-"` // shortened ID, for use in pseudo-version

A Rev describes a single revision in a module repository.

func Stat Uses

func Stat(proxy, path, rev string) (*RevInfo, error)

Stat is like Lookup(path).Stat(rev) but avoids the repository path resolution in Lookup if the result is already cached on local disk.


codehostPackage codehost defines the interface implemented by a code hosting source, along with support code for use by implementations.

Package modfetch imports 34 packages (graph) and is imported by 22 packages. Updated 2020-12-06. Refresh now. Tools for package owners.