package stdlib

Import Path
	golang.org/x/pkgsite/internal/stdlib (on go.dev)

Dependency Relation
	imports 21 packages, and imported by 9 packages

Involved Source Files

	   d➜ stdlib.go
		Package stdlib supports special handling of the Go standard library.
		Regardless of the how the standard library has been split into modules for
		development and testing, the discovery site treats it as a single module
		named "std".
Package-Level Functions (total 16, in which 8 are exported)

	 func Contains(path string) bool
		Contains reports whether the given import path could be part of the Go standard library,
		by reporting whether the first component lacks a '.'.

	 func Directory(version string) string
		Directory returns the directory of the standard library relative to the repo root.

	 func MajorVersionForVersion(version string) (_ string, err error)
		MajorVersionForVersion returns the Go major version for version.
		E.g. "v1.13.3" => "go1".

	 func TagForVersion(version string) (_ string, err error)
		TagForVersion returns the Go standard library repository tag corresponding
		to semver. The Go tags differ from standard semantic versions in a few ways,
		such as beginning with "go" instead of "v".

	 func VersionForTag(tag string) string
		VersionForTag returns the semantic version for the Go tag, or "" if
		tag doesn't correspond to a Go release or beta tag. In special cases,
		when the tag specified is either `latest` or `master` it will return the tag.
		Examples:
		  "go1" => "v1.0.0"
		  "go1.2" => "v1.2.0"
		  "go1.13beta1" => "v1.13.0-beta.1"
		  "go1.9rc2" => "v1.9.0-rc.2"
		  "latest" => "latest"
		  "master" => "master"

	 func Versions() (_ []string, err error)
		Versions returns all the versions of Go that are relevant to the discovery
		site. These are all release versions (tags of the forms "goN.N" and
		"goN.N.N", where N is a number) and beta or rc versions (tags of the forms
		"goN.NbetaN" and "goN.N.NbetaN", and similarly for "rc" replacing "beta").

	 func Zip(resolvedVersion string) (_ *zip.Reader, resolvedVersion2 string, commitTime time.Time, err error)
		Zip creates a module zip representing the entire Go standard library at the
		given version (which must have been resolved with ZipInfo) and returns a
		reader to it. It also returns the time of the commit for that version. The
		zip file is in module form, with each path prefixed by ModuleName + "@" +
		version.

		Normally, Zip returns the resolved version it was passed. If the resolved
		version is "master", Zip returns a semantic version for the branch.

		Zip reads the standard library at the Go repository tag corresponding to to
		the given semantic version.

		Zip ignores go.mod files in the standard library, treating it as if it were a
		single module named "std" at the given version.

	 func ZipInfo(requestedVersion string) (resolvedVersion string, err error)
		ZipInfo returns the proxy .info information for the module std.

	/* 8 unexporteds ... *//* 8 unexporteds: */
	 func addFiles(z *zip.Writer, r *git.Repository, t *object.Tree, dirpath string, recursive bool) (err error)
		addFiles adds the files in t to z, using dirpath as the path prefix.
		If recursive is true, it also adds the files in all subdirectories.

	 func finalDigitsIndex(s string) int
		finalDigitsIndex returns the index of the first digit in the sequence of digits ending s.
		If s doesn't end in digits, it returns -1.

	 func getGoRepo(version string) (_ *git.Repository, err error)
		getGoRepo returns a repo object for the Go repo at version.

	 func getTestGoRepo(version string) (_ *git.Repository, err error)
		getTestGoRepo gets a Go repo for testing.

	 func newPseudoVersion(version string, commitTime time.Time, hash plumbing.Hash) string
	 func semanticVersion(requestedVersion string) (_ string, err error)
		semanticVersion returns the semantic version corresponding to the
		requestedVersion. If the requested version is "master", then semanticVersion
		returns it as is. The branch name is resolved to a proper pseudo-version in
		Zip.

	 func subTree(r *git.Repository, t *object.Tree, name string) (_ *object.Tree, err error)
		subTree looks non-recursively for a directory with the given name in t,
		and returns the corresponding tree.
		If a directory with such name doesn't exist in t, it returns os.ErrNotExist.

	 func writeZipFile(z *zip.Writer, pathname string, src io.Reader) (err error)
Package-Level Variables (total 5, in which 3 are exported)

	  var TestCommitTime time.Time
		TestCommitTime is the time used for all commits when UseTestData is true.

	  var TestVersion string
		TestCommitTime is the time used for all commits when UseTestData is true.

	  var UseTestData bool
		UseTestData determines whether to really clone the Go repo, or use
		stripped-down versions of the repo from the testdata directory.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var tagRegexp *regexp.Regexp
		Regexp for matching go tags. The groups are:
		1  the major.minor version
		2  the patch version, or empty if none
		3  the entire prerelease, if present
		4  the prerelease type ("beta" or "rc")
		5  the prerelease number

	  var testRefs []plumbing.ReferenceName
		References used for Versions during testing.


Package-Level Constants (total 4, all are exported)

	const EstimatedZipSize = 16777216
		EstimatedZipSize is the approximate size of
		Zip("v1.15.2").

	const GoRepoURL = "https://go.googlesource.com/go"
	const GoSourceRepoURL = "https://cs.opensource.google/go/go"
	const ModulePath = "std"
		ModulePath is the name of the module for the standard library.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.