match

Documentation

Overview

Package match provides functionality for conveniently matching a v1.Descriptor.

Index

• type Matcher
  • func Annotation(key, value string) Matcher
  • func MediaTypes(mediaTypes []string) Matcher
  • func Name(name string) Matcher
  • func Platform(platform v1.Platform) Matcher

Types

type Matcher

type Matcher func(desc v1.Descriptor) bool

Matcher function that is given a v1.Descriptor, and returns whether or not it matches a given rule. Can match on anything it wants in the Descriptor.

func Annotation

func Annotation(key, value string) Matcher

Annotation returns a match.Matcher that matches based on the provided annotation.

func MediaTypes

func MediaTypes(mediaTypes []string) Matcher

MediaTypes returns a match.Matcher that matches at least one of the provided media types.

func Name

func Name(name string) Matcher

Name returns a match.Matcher that matches based on the value of the

"org.opencontainers.image.ref.name" annotation:

github.com/opencontainers/image-spec/blob/v1.0.1/annotations.md#pre-defined-annotation-keys

func Platform

func Platform(platform v1.Platform) Matcher

Platform returns a match.Matcher that matches on the provided platform. Ignores any descriptors that do not have a platform.