containerwalker

Documentation

Index

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

Types

type ContainerWalker

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

func (*ContainerWalker) Walk

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

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

func (*ContainerWalker) WalkAll

func (w *ContainerWalker) 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 Found

type Found struct {
	Container  containerd.Container
	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.
}

type OnFound

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