downloader

Documentation

Index

• Variables
• func IsLocal(s string) bool
• type Opt
  • func WithCache() Opt
  • func WithCacheDir(cacheDir string) Opt
  • func WithDecompress(decompress bool) Opt
  • func WithDescription(description string) Opt
  • func WithExpectedDigest(expectedDigest digest.Digest) Opt
• type Result
  • func Cached(remote string, opts ...Opt) (*Result, error)
  • func Download(ctx context.Context, local, remote string, opts ...Opt) (*Result, error)
• type Status

Variables

var HideProgress bool

HideProgress is used only for testing

Functions

func IsLocal

func IsLocal(s string) bool

Types

type Opt

type Opt func(*options) error

func WithCache

func WithCache() Opt

WithCache enables caching using filepath.Join(os.UserCacheDir(), "lima") as the cache dir.

func WithCacheDir

func WithCacheDir(cacheDir string) Opt

WithCacheDir enables caching using the specified dir. Empty value disables caching.

func WithDecompress

func WithDecompress(decompress bool) Opt

WithDecompress decompress the download from the cache.

func WithDescription

func WithDescription(description string) Opt

WithDescription adds a user description of the download.

func WithExpectedDigest

func WithExpectedDigest(expectedDigest digest.Digest) Opt

WithExpectedDigest is used to validate the downloaded file against the expected digest.

The digest is not verified in the following cases: - The digest was not specified. - The file already exists in the local target path.

When the `data` file exists in the cache dir with `<ALGO>.digest` file, the digest is verified by comparing the content of `<ALGO>.digest` with the expected digest string. So, the actual digest of the `data` file is not computed.

type Result

type Result struct {
	Status          Status
	CachePath       string // "/Users/foo/Library/Caches/lima/download/by-url-sha256/<SHA256_OF_URL>/data"
	ValidatedDigest bool
}

func Cached

func Cached(remote string, opts ...Opt) (*Result, error)

Cached checks if the remote resource is in the cache.

Download caches the remote resource if WithCache or WithCacheDir option is specified. Local files are not cached.

When the cache path already exists, Cached returns Result with StatusUsedCache.

func Download

func Download(ctx context.Context, local, remote string, opts ...Opt) (*Result, error)

Download downloads the remote resource into the local path.

Download caches the remote resource if WithCache or WithCacheDir option is specified. Local files are not cached.

When the local path already exists, Download returns Result with StatusSkipped. (So, the local path cannot be set to /dev/null for "caching only" mode.)

The local path can be an empty string for "caching only" mode.

type Status

type Status = string

const (
	StatusUnknown    Status = ""
	StatusDownloaded Status = "downloaded"
	StatusSkipped    Status = "skipped"
	StatusUsedCache  Status = "used-cache"
)