Function FilterImage

private/bufpkg/bufimage/bufimageutil/bufimageutil.go:249–263

FilterImage returns a minimal image containing only the descriptors required to define the set of types provided by the filter options. If no filter options are provided, the original image is returned. The filtered image will contain only the files that contain the definitions of the specified typ

(image bufimage.Image, options ...ImageFilterOption)

//	 messages:   [pkg.Baz, other.Quux, other.Qux]
//	 extensions: [other.my_option]
func FilterImage(image bufimage.Image, options ...ImageFilterOption) (bufimage.Image, error) {
	if len(options) == 0 {
		return image, nil
	}
	filterOptions := newImageFilterOptions()
	for _, option := range options {
		option(filterOptions)
	}
	// Check for defaults that would result in no filtering.
	if len(filterOptions.excludeTypes) == 0 &&
		len(filterOptions.includeTypes) == 0 {
		return image, nil
	}
	return filterImage(image, filterOptions)
}

// StripSourceRetentionOptions strips any options with a retention of "source" from
// the descriptors in the given image. The image is not mutated but instead a new