Interface Getter

get.go:29–54

Getter defines the interface that schemes must implement to download things.

// Getter defines the interface that schemes must implement to download
// things.
type Getter interface {
	// Get downloads the given URL into the given directory. This always
	// assumes that we're updating and gets the latest version that it can.
	//
	// The directory may already exist (if we're updating). If it is in a
	// format that isn't understood, an error should be returned. Get shouldn't
	// simply nuke the directory.
	Get(context.Context, *Request) error

	// GetFile downloads the give URL into the given path. The URL must
	// reference a single file. If possible, the Getter should check if
	// the remote end contains the same file and no-op this operation.
	GetFile(context.Context, *Request) error

	// Mode returns the mode based on the given URL. This is used to
	// allow clients to let the getters decide which mode to use.
	Mode(context.Context, *url.URL) (Mode, error)

	// Detect detects whether the Request.Src matches a known pattern to
	// turn it into a proper URL, and also transforms and update Request.Src
	// when necessary.
	// The Getter must validate if the Request.Src is a valid URL
	// with a valid scheme for the Getter, and also check if the
	// current Getter is the forced one and return true if that's the case.
	Detect(*Request) (bool, error)
}

// Getters is the mapping of scheme to the Getter implementation that will
// be used to get a dependency.