package modfetch

import "cmd/go/internal/modfetch"

Index ¶

• Variables
• func CachePath(m module.Version, suffix string) (string, error)
• func Download(mod module.Version) (dir string, err error)
• func DownloadDir(m module.Version) (string, error)
• func DownloadZip(mod module.Version) (zipfile string, err error)
• func GoMod(path, rev string) ([]byte, error)
• func GoModFile(path, version string) (string, error)
• func GoModSum(path, version string) (string, error)
• func ImportRepoRev(path, rev string) (Repo, *RevInfo, error)
• func InfoFile(path, version string) (string, error)
• func IsPseudoVersion(v string) bool
• func PseudoVersion(major, older string, t time.Time, rev string) string
• func PseudoVersionBase(v string) (string, error)
• func PseudoVersionRev(v string) (rev string, err error)
• func PseudoVersionTime(v string) (time.Time, error)
• func RemoveAll(dir string) error
• func SideLock() (unlock func())
• func SortVersions(list []string)
• func Sum(mod module.Version) string
• func TrimGoSum(keep map[module.Version]bool)
• func TryProxies(f func(proxy string) error) error
• func Unzip(dir, zipfile, prefix string, maxSize int64) error
• func WriteGoSum()
• type Repo
• func Lookup(proxy, path string) (Repo, error)
• type RevInfo
• func Stat(proxy, path, rev string) (*RevInfo, error)

Variables ¶

var GoSumFile string // path to go.sum; set by package modload

var HelpGoproxy = &base.Command{
	UsageLine: "goproxy",
	Short:     "module proxy protocol",
	Long:      "" /* 2166 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 */,
}

var PkgMod string // $GOPATH/pkg/mod; set by package modload

var QuietLookup bool // do not print about lookups

Functions ¶

func CachePath ¶

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

func Download ¶

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 ¶

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

DownloadDir returns the directory to which m should be downloaded. Note that the directory may not yet exist.

func DownloadZip ¶

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 ¶

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 ¶

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

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

func GoModSum ¶

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 ¶

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 ¶

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

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

func IsPseudoVersion ¶

func IsPseudoVersion(v string) bool

IsPseudoVersion reports whether v is a pseudo-version.

func PseudoVersion ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

func SideLock() (unlock func())

SideLock locks a file within the module cache that that guards edits to files outside the cache, such as go.sum and go.mod files in the user's working directory. It returns a function that must be called to unlock the file.

func SortVersions ¶

func SortVersions(list []string)

func Sum ¶

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 ¶

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

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

func TryProxies ¶

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

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

TryProxies then returns that final error.

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

func Unzip ¶

func Unzip(dir, zipfile, prefix string, maxSize int64) error

func WriteGoSum ¶

func WriteGoSum()

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

Types ¶

type Repo ¶

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) (tags []string, err 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 ¶

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 ¶

type RevInfo struct {
	Version string    // version string
	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 ¶

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.

Source Files ¶

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

Directories ¶