imagewalker

Documentation

Index

• type Found
• type ImageWalker
  • func (w *ImageWalker) Walk(ctx context.Context, req string) (int, error)
  • func (w *ImageWalker) WalkAll(ctx context.Context, reqs []string, forceAll bool) error
• type OnFound

Types

type Found

type Found struct {
	Image        images.Image
	Req          string // The raw request string. name, short ID, or long ID.
	MatchIndex   int    // Begins with 0, up to MatchCount - 1.
	MatchCount   int    // 1 on exact match. > 1 on ambiguous match. Never be <= 0.
	UniqueImages int    // Number of unique images in all found images.
}

type ImageWalker

type ImageWalker struct {
	Client  *containerd.Client
	OnFound OnFound
}

func (*ImageWalker) Walk

func (w *ImageWalker) Walk(ctx context.Context, req string) (int, error)

Walk walks images and calls w.OnFound . Req is name, short ID, or long ID. Returns the number of the found entries.

func (*ImageWalker) WalkAll

func (w *ImageWalker) WalkAll(ctx context.Context, reqs []string, forceAll bool) error

WalkAll calls `Walk` for each req in `reqs`.

It can be used when the matchCount is not important (e.g., only care if there is any error or if matchCount == 0 (not found error) when walking all reqs). If `forceAll`, it calls `Walk` on every req and return all errors joined by `\n`. If not `forceAll`, it returns the first error encountered while calling `Walk`.

type OnFound

type OnFound func(ctx context.Context, found Found) error