package proxydatasource

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

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	   d➜ datasource.go
		Package proxydatasource implements an internal.DataSource backed solely by a
		proxy instance.

	   d➜ details.go
		Package proxydatasource implements an internal.DataSource backed solely by a
		proxy instance.
Package-Level Type Names (total 3, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type DataSource (struct)
		DataSource implements the frontend.DataSource interface, by querying a
		module proxy directly and caching the results in memory.

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			bypassLicenseCheck bool
			modulePathToVersions map[string][]string
				map of modulePath -> versions, with versions sorted in semver order

			mu sync.RWMutex
				Use an extremely coarse lock for now - mu guards all maps below. The
				assumption is that this will only be used for local development.

			packagePathToModules map[string][]string
				map of package path -> modules paths containing it, with module paths
				sorted by descending length

			proxyClient *proxy.Client
			sourceClient *source.Client
			versionCache map[versionKey]*versionEntry
		Methods (total 11, in which 7 are exported)
			(*T) GetExperiments(ctx context.Context) ([]*internal.Experiment, error)
				GetExperiments is unimplemented.

			(*T) GetLatestInfo(ctx context.Context, unitPath, modulePath string, latestUnitMeta *internal.UnitMeta) (latest internal.LatestInfo, err error)
				GetLatestInfo returns latest information for unitPath and modulePath.

			(*T) GetModuleInfo(ctx context.Context, modulePath, version string) (_ *internal.ModuleInfo, err error)
				GetModuleInfo returns the ModuleInfo as fetched from the proxy for module
				version specified by modulePath and version.

			(*T) GetModuleReadme(ctx context.Context, modulePath, resolvedVersion string) (*internal.Readme, error)
				GetModuleReadme is unimplemented.

			(*T) GetNestedModules(ctx context.Context, modulePath string) (_ []*internal.ModuleInfo, err error)
				GetNestedModules will return an empty slice since it is not implemented in proxy mode.

			(*T) GetUnit(ctx context.Context, um *internal.UnitMeta, field internal.FieldSet, bc internal.BuildContext) (_ *internal.Unit, err error)
				GetUnit returns information about a directory at a path.

			(*T) GetUnitMeta(ctx context.Context, path, inModulePath, inVersion string) (_ *internal.UnitMeta, err error)
				GetUnitMeta returns information about the given path.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) findModule(ctx context.Context, pkgPath string, version string) (_ string, _ *proxy.VersionInfo, err error)
				findModule finds the longest module path containing the given package path,
				using the given finder func and iteratively testing parent directories of
				the import path. It performs no testing as to whether the specified module
				version that was found actually contains a package corresponding to pkgPath.

			(*T) getLatestMajorVersion(ctx context.Context, fullPath, modulePath string) (_ string, _ string, err error)
				getLatestMajorVersion returns the latest module path and the full package path
				of the latest version found in the proxy by iterating through vN versions.
				This function does not attempt to find whether the full path exists
				in the new major version.

			(*T) getModule(ctx context.Context, modulePath, version string, _ internal.BuildContext) (_ *internal.Module, err error)
				getModule retrieves a version from the cache, or failing that queries and
				processes the version from the proxy.

			(*T) getUnit(ctx context.Context, fullPath, modulePath, version string, bc internal.BuildContext) (_ *internal.Unit, err error)
				getUnit returns information about a unit.

		Implements (at least one exported)
			*T : golang.org/x/pkgsite/internal.DataSource
		As Outputs Of (at least 4, in which 3 are exported)
			func New(proxyClient *proxy.Client) *DataSource
			func NewBypassingLicenseCheck(c *proxy.Client) *DataSource
			func NewForTesting(proxyClient *proxy.Client) *DataSource
			/* at least one unexported ... *//* at least one unexported: */
			func newDataSource(proxyClient *proxy.Client, sourceClient *source.Client) *DataSource

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type versionEntry (struct)
		versionEntry holds the result of a call to worker.FetchModule.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			err error
			module *internal.Module

	 type versionKey (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			modulePath string
			version string


Package-Level Functions (total 4, in which 3 are exported)

	 func New(proxyClient *proxy.Client) *DataSource
		New returns a new direct proxy datasource.

	 func NewBypassingLicenseCheck(c *proxy.Client) *DataSource
		NewBypassingLicenseCheck returns a new direct proxy datasource that bypasses
		license checks. That means all data will be returned for non-redistributable
		modules, packages and directories.

	 func NewForTesting(proxyClient *proxy.Client) *DataSource
	/* one unexported ... *//* one unexported: */
	 func newDataSource(proxyClient *proxy.Client, sourceClient *source.Client) *DataSource

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.