package localdatasource

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

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	   d➜ datasource.go
		Package localdatasource implements an in-memory internal.DataSource used to load
		and display documentation for local modules that are not available via a proxy.
		Similar to proxydatasource, search and other tabs are not supported in this mode.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type DataSource (struct)
		DataSource implements an in-memory internal.DataSource used to display documentation
		locally. DataSource is not backed by a database or a proxy instance.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			loadedModules map[string]*internal.Module
			mu sync.Mutex
			sourceClient *source.Client
		Methods (total 9, in which 7 are exported)
			(*T) GetLatestInfo(ctx context.Context, unitPath, modulePath string, latestUnitMeta *internal.UnitMeta) (internal.LatestInfo, error)
				GetLatestInfo is not implemented.

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

			(*T) GetNestedModules(ctx context.Context, modulePath string) ([]*internal.ModuleInfo, error)
				GetNestedModules is not implemented.

			(*T) GetUnit(ctx context.Context, pathInfo *internal.UnitMeta, fields internal.FieldSet, bc internal.BuildContext) (_ *internal.Unit, err error)
				GetUnit returns information about a unit. Both the module path and package
				path must be known.

			(*T) GetUnitMeta(ctx context.Context, path, requestedModulePath, requestedVersion string) (_ *internal.UnitMeta, err error)
				GetUnitMeta returns information about a path.

			(*T) Load(ctx context.Context, localPath string) (err error)
				Load loads a module from the given local path. Loading is required before
				being able to display the module.

			(*T) LoadFromGOPATH(ctx context.Context, importPath string) (err error)
				LoadFromGOPATH loads a module from GOPATH using the given import path. The full
				path of the module should be GOPATH/src/importPath. If several GOPATHs exist, the
				module is loaded from the first one that contains the import path. Loading is required
				before being able to display the module.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) fetch(ctx context.Context, modulePath, localPath string) error
				fetch fetches a module using FetchLocalModule and adds it to the datasource.
				If the fetching fails, an error is returned.

			(*T) findModule(pkgPath string) (_ string, err error)
				findModule finds the longest module path in loadedModules containing the given
				package path. It iteratively checks parent directories to find an import path.
				Returns an error if no module is found.

		Implements (at least one exported)
			*T : golang.org/x/pkgsite/internal.DataSource
		As Outputs Of (at least one exported)
			func New() *DataSource
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func golang.org/x/pkgsite/cmd/pkgsite.load(ctx context.Context, ds *DataSource, pathList string)


Package-Level Functions (total 2, in which 1 are exported)

	 func New() *DataSource
		New creates and returns a new local datasource that bypasses license
		checks by default.

	/* one unexported ... *//* one unexported: */
	 func getFullPath(modulePath string) string
		getFullPath takes an import path, tests it relative to each GOPATH, and returns
		a full path to the module. If the given import path doesn't exist in any GOPATH,
		an empty string is returned.

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.