proxy

Documentation

Overview

Package proxy provides support for fetching modules from a Go module proxy.

Index

• Constants
• Variables
• type Client
  • func (c *Client) Files(mod *internal.Module) (fs.FS, error)
  • func (c *Client) Module(modulePath, version string) (*internal.Module, error)
  • func (c *Client) ZipSize(ctx context.Context, modulePath, resolvedVersion string) (int64, error)

Constants

const (
	// The Go toolchain module path
	StdlibModulePath = "std"

	// The Go toolchain module path
	ToolchainModulePath = "golang.org/toolchain"
)

Variables

var (
	// ErrProxyTimedOut indicates that a request to the module proxy timed out.
	ErrProxyTimedOut = errors.New("proxy timed out")
)

Types

type Client

type Client struct {
	// URL of the module proxy web server.
	URL string

	// Client used for HTTP requests.
	HTTPClient *http.Client

	// MaxZipSize is the maximum zip file size allowed for reading.
	MaxZipSize int64
}

Client fetches Go modules from a module proxy.

func (*Client) Files

func (c *Client) Files(mod *internal.Module) (fs.FS, error)

Files returns the module's files.

func (*Client) Module

func (c *Client) Module(modulePath, version string) (*internal.Module, error)

Module fetches a module from the module proxy.

func (*Client) ZipSize

func (c *Client) ZipSize(ctx context.Context, modulePath, resolvedVersion string) (int64, error)

ZipSize gets the size in bytes of the zip from the proxy, without downloading it. The version must be resolved, as by a call to Client.Info.