package version

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

Dependency Relation
	imports 4 packages, and imported by 6 packages

Involved Source Files

	   d➜ version.go
		Package version handles version types.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Type string (basic type)
		Type defines the version types a module can have.
		This must be kept in sync with the 'version_type' database enum.

		Methods (only one, which is exported)
			( T) String() string
		Implements (at least 4, in which 2 are exported)
			 T : expvar.Var
			 T : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 T : context.stringer
			 T : runtime.stringer
		As Outputs Of (at least one exported)
			func ParseType(version string) (Type, error)
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func golang.org/x/pkgsite/internal/postgres.getPathVersions(ctx context.Context, db *postgres.DB, path string, versionTypes ...Type) (_ []*internal.ModuleInfo, err error)
			func golang.org/x/pkgsite/internal/postgres.versionTypeExpr(vts []Type) string
		As Types Of (total 3, all are exported)
			const TypePrerelease
			const TypePseudo
			const TypeRelease


Package-Level Functions (total 9, in which 8 are exported)

	 func ForSorting(version string) string
		ForSorting returns a string that encodes version, so that comparing two such
		strings follows SemVer precedence, https://semver.org clause 11. It assumes
		version is valid. The returned string ends in '~' if and only if the version
		does not have a prerelease.

		For examples, see TestForSorting.

	 func IsIncompatible(v string) bool
		IsIncompatible reports whether a valid version v is an incompatible version.

	 func IsPseudo(v string) bool
		IsPseudo reports whether a valid version v is a pseudo-version.
		Modified from src/cmd/go/internal/modfetch.

	 func Later(v1, v2 string) bool
		Later reports whether v1 is later than v2, using semver but preferring
		release versions to pre-release versions, and both to pseudo-versions.

	 func Latest(versions []string, hasGoMod func(v string) (bool, error)) (v string, err error)
		Latest finds the latest version of a module using the same algorithm as the
		Go command. It prefers tagged release versions to tagged pre-release
		versions, and both of those to pseudo-versions. If versions is empty, Latest
		returns the empty string.

		hasGoMod should report whether the version it is given has a go.mod file.
		Latest returns the latest incompatible version only if the latest compatible
		version does not have a go.mod file.

		The meaning of latest is defined at
		https://golang.org/ref/mod#version-queries. That definition does not deal
		with retractions, or with a subtlety involving incompatible versions. The
		actual definition is embodied in the go command's queryMatcher.filterVersions
		method. This function is a re-implementation and specialization of that
		method at Go version 1.16
		(https://go.googlesource.com/go/+/refs/tags/go1.16/src/cmd/go/internal/modload/query.go#441).

	 func LatestOf(versions []string) string
		LatestOf returns the latest version of a module from a list of versions, using
		the go command's definition of latest: semver is observed, except that
		release versions are preferred to prerelease, and both are preferred to pseudo-versions.
		If versions is empty, the empty string is returned.

	 func ParseType(version string) (Type, error)
		ParseType returns the Type of a given a version.

	 func RemoveIf(s []string, f func(string) bool) []string
		RemoveIf returns a copy of s that omits all values for which f returns true.

	/* one unexported ... *//* one unexported: */
	 func appendNumericPrefix(dst []byte, n int) []byte
		appendNumericPrefix appends a string representing n to dst.
		n is the length of a digit string; the value we append is a prefix for the
		digit string s such that
		  prefix1 + s1 < prefix2 + s2
		if and only if the integer denoted by s1 is less than the one denoted by s2.
		In other words, prefix + s is a string that can be compared with other such
		strings while preserving the ordering of the numbers.

		If n==1, there is no prefix. (Single-digit numbers are unchanged.)
		Otherwise, the prefix is a sequence of lower-case letters encoding n.
		Examples:
		  n    prefix
		  1    <none>
		  2    a
		  27   z
		  28   za
		  53   zz
		  54   zza
		This encoding depends on the ASCII properties that:
		- digits are ordered numerically
		- letters are ordered alphabetically
		- digits order before letters (so "1" < "a10")


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var pseudoVersionRE *regexp.Regexp
Package-Level Constants (total 3, all are exported)

	const TypePrerelease Type = "prerelease"
		TypePrerelease is a version with a prerelease.

	const TypePseudo Type = "pseudo"
		TypePseudo appears to have a prerelease of the
		form <commit date>-<commit hash>.

	const TypeRelease Type = "release"
		TypeRelease is a normal release.

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.